/webshop/orders/{orderid}

Endpoint

Autorisation

Bearer-nøgle medwebshop:orders:read

Path-parametre

orderidstring · påkrævet

TCGM-ordrens id fra oprettelsessvaret eller et ordreopslag (wshop_o_…). Brug ikke externalId, providerOrderId eller orderNumber.

path.orderid (påkrævet)

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)

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

Den aktuelle ordre.

Cache-Control: no-store

{
  order: {
    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;
    }>;
  };
}

Statuskoder

200

Den aktuelle ordre.

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;
}