API

Obtenir les référentiels pour le formulaire de commande

GET/api/crm/v2/orders.fieldsv2
operationId: orders.fields

Renvoie les référentiels pour le formulaire de commande. order_status contient les transitions disponibles depuis le statut actuel.

Autorisation

api-token + language + role

Paramètres de requête

order_statusstring (OrderStatus) obligatoire

Statut de la commande : en cours de livraison, terminé, en préparation, en cuisine, non traité, prêt à être expédié, en attente d'envoi en cuisine, en attente de reprise, annulé, confirmé, préparé

Valeurs:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemple: confirmed

branch_idintegerobligatoire

Exemple: 8779

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
order_statusobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

courier_service_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

pickup_address_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required