POST

Effacer les statuts d'articles

Supprimer le statut actuel (et le sous-statut) d'un ou plusieurs articles. Maximum 100 articles par requête.

Point de terminaison

Requête HTTP
POST /v1/line-items/clear-status

Authentification

Ce point de terminaison nécessite une clé API valide avec la permission canChangeOrderStatus . La clé API doit être passée dans l'en-tête X-API-Key .
En-tête requis
X-API-Key: your_api_key_here

Corps de la requête

ParamètreTypeRequisDéfautDescription
line_item_idsstring[]Oui-Tableau d'ID d'articles internes (1–100)

Réponse

Retourne la confirmation avec le nombre d'articles dont le statut a été effacé:
200 OK - Réponse de succès
{
  "success": true,
  "data": {
    "message": "2 line item(s) status cleared",
    "affected_count": 2,
    "requested_count": 2
  }
}

Champs de réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
dataobjectObjet de données de réponse
messagestringMessage de confirmation
affected_countnumberNombre d'articles dont le statut a été effacé
requested_countnumberNombre total d'articles demandés

Notes

  • •Maximum 100 articles par requête.
  • •Ne déclenche pas de notifications.
  • •Les champs méta sont reconstruits pour toutes les commandes parentes affectées.

Exemples

Requête de base

Requête cURL
curl -X POST "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/line-items/clear-status" \
  -H "X-API-Key: your_api_key_here" \
  -H "X-API-Version: 1.4" \
  -H "Content-Type: application/json" \
  -d '{
    "line_item_ids": ["li-uuid-1", "li-uuid-2"]
  }'

Limitation de débit

Ce point de terminaison est soumis à des limites de débit par minute et par jour en fonction de votre clé API. Les informations de limite de débit sont renvoyées dans les en-têtes de réponse:
  • X-RateLimit-Limit-Minute: Nombre maximum de requêtes par minute
  • X-RateLimit-Remaining-Minute: Requêtes restantes dans la minute en cours
  • X-RateLimit-Reset-Minute: Horodatage Unix de réinitialisation de la fenêtre minute
  • X-RateLimit-Limit-Day: Nombre maximum de requêtes par jour
  • X-RateLimit-Remaining-Day: Requêtes restantes dans le jour en cours
  • X-RateLimit-Reset-Day: Horodatage Unix de réinitialisation de la fenêtre jour
  • Retry-After: Secondes à attendre avant de réessayer (en cas de limitation)

Réponses d'erreur

400 Requête invalide

Statut d'article non activé, validation échouée, ou opération d'effacement échouée

400 Requête invalide
{
  "success": false,
  "error": "Line item status changes are not enabled. Set status tracking level to \"line_item\" or \"combined\" in settings."
}

401 Non autorisé

Clé API manquante ou invalide

401 Non autorisé
{
  "error": "Unauthorized"
}

403 Interdit

La clé API manque de permissions requises

403 Interdit
{
  "error": "Insufficient permissions"
}

500 Erreur interne du serveur

Une erreur du serveur s'est produite

500 Erreur interne du serveur
{
  "error": "Internal server error",
  "details": {
    "message": "Error description"
  }
}