Vendure · Example Payload

Vendure Shop Active Order Example

Example: query the active order via the Vendure Shop API.

CommerceHeadless CommerceeCommerceGraphQLOpen SourceTypeScriptNestJSB2BB2CStorefrontPlugins

Vendure Shop Active Order Example is an example object payload from Vendure, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

{
  "description": "Example: query the active order via the Vendure Shop API.",
  "request": {
    "method": "POST",
    "url": "http://localhost:3000/shop-api",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "vendure-token": "default-channel-token"
    },
    "body": {
      "query": "query ActiveOrder { activeOrder { id code state totalQuantity totalWithTax currencyCode lines { id quantity productVariant { id name sku } unitPriceWithTax linePriceWithTax } } }"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "data": {
        "activeOrder": {
          "id": "1",
          "code": "1XJTYJB99CSHV9JE",
          "state": "AddingItems",
          "totalQuantity": 2,
          "totalWithTax": 4998,
          "currencyCode": "USD",
          "lines": [
            {
              "id": "1",
              "quantity": 2,
              "productVariant": { "id": "42", "name": "Headphones — Black", "sku": "HP-BLK-01" },
              "unitPriceWithTax": 2499,
              "linePriceWithTax": 4998
            }
          ]
        }
      }
    }
  }
}