/webshop/orders

Endpoint

Autorisation

Bearer-nøgle medwebshop:orders:read

Query-parametre

organizationstring · påkrævet

Organisationens ID fra /api/v1/access. Trimmes før validering. Mindst 1 tegn. Højst 200 tegn.

query.organization (påkrævet)

webshopstring · påkrævet

Netbutikkens ID fra /api/v1/access. Trimmes før validering. Mindst 1 tegn. Højst 200 tegn.

query.webshop (påkrævet)

statestring · valgfri

Åbne, afsluttede eller alle ordrer. Tilladte værdier: "open", "closed", "all". Standard: "open".

query.state (valgfri)

Udelad feltopenclosedall

limitinteger · valgfri

Heltal 1–100, standard 25. Standard: 25. Minimum: 1. Maksimum: 100.

query.limit (valgfri)

afterstring · valgfri

Brug nextCursor fra det forrige svar uændret. Højst 200 tegn.

query.after (valgfri)

Headers

Authorizationstring · påkrævet

Bearer <api-nøgle>. Nøglen oprettes af en owner/admin på organisationens API-side.

header.Authorization (påkrævet)

Gemmes kun i denne sides hukommelse.

Response · 200

Ordreside. nextCursor er null, når der ikke er en næste side.

Cache-Control: no-store

{
  orders: Array<{
    id: string;
    externalId: string;
    providerOrderId: string;
    orderNumber: string | null;
    displayName: string;
    creatorTag: string | null;
    syncedBy: string | null;
    createdAt: string;
    receivedAt: string;
    updatedAt: string;
    completedAt: string | null;
    queue: {
      hidden: boolean;
      position: number | null;
      preparing: boolean;
    };
    lines: Array<{
      id: string;
      externalId: string;
      productId: string;
      variantId: string | null;
      itemName: string;
      quantity: number;
    }>;
  }>;
  nextCursor: string | null;
}

Statuskoder

200

Ordreside. nextCursor er null, når der ikke er en næste side.

400

Ugyldigt input: invalid_request.

401

Manglende eller ugyldig Bearer-nøgle: invalid_credential.

403

Adgang nægtet: nøgle, scope, ejerskab eller godkendelse er ikke længere gyldig.

404

Ressourcen findes ikke eller er ikke tilgængelig.

503

Lager eller behandling er utilgængelig. Ingen interne fejl eller skemadetaljer udleveres i produktion.

405

HTTP-metoden understøttes ikke.

Cache-Control: no-store

{
  error: string;
}

Cache-Control: no-store
WWW-Authenticate: Bearer

{
  error: string;
}