Skip to main content
GET
Lister les commandes d’une organisation

Autorisations

x-api-key
string
header
requis

Clé API d’établissement ou d’organisation.

Paramètres de chemin

organization_id
string
requis

Paramètres de requête

limit
integer
défaut:10

Taille de page (1–100).

Plage requise: 1 <= x <= 100
starting_after
string

Retourne les commandes après cet identifiant de commande.

ending_before
string

Retourne les commandes avant cet identifiant de commande.

created_after
string<date-time>

Retourne les commandes créées après cet horodatage ISO 8601.

created_before
string<date-time>

Retourne les commandes créées avant cet horodatage ISO 8601.

updated_after
string<date-time>

Retourne les commandes mises à jour après cet horodatage ISO 8601. Pour la réconciliation, combinez-le à une borne haute updated_before fixe sur toutes les pages.

updated_before
string<date-time>

Retourne les commandes mises à jour avant cet horodatage ISO 8601. Conservez cette borne haute inchangée pendant toute la pagination d’une réconciliation.

status
enum<string>
Options disponibles:
received,
accepted,
in_preparation,
awaiting_shipment,
awaiting_collection,
in_delivery,
completed,
rejected,
cancelled,
delivery_failed
service_type
enum<string>
Options disponibles:
delivery,
collection,
eat_in
location_id
string

Limite les résultats à un établissement de l’organisation.

Réponse

Une liste paginée de commandes.

object
enum<string>
requis
Options disponibles:
list
data
object[]
requis
has_more
boolean
requis
url
string
requis