arazzo: 1.0.1
info:
title: Commerce Layer Create Order and Add Line Item
summary: Create a draft order in a market, add a SKU line item to it, then read the order back.
description: >-
The foundational Commerce Layer cart-building flow. The workflow creates a
draft order scoped to a market, attaches a line item referencing a SKU by
code with a quantity, and then retrieves the order so the caller can read
the recalculated totals and item count. Every step spells out its JSON:API
request inline so the flow can be read and executed without opening the
underlying OpenAPI description.
version: 1.0.0
x-realizes-capability-ids:
- BC-520.40
x-capability-derivation:
method: 'deterministic join: sourceDescriptions -> per-tag OpenAPI -> tag/capability edge. No classification at this step.'
min_confidence: 0.7
sources:
- capability_id: BC-520.40
capability_name: Order Fulfilment Management
spec: commerce-layer-orders-api-openapi.yml
confidence: 0.7
model: Turbo EA Capabilities by Vincent Verdet — Turbo EA, https://github.com/vincentmakes/turbo-ea-capabilities, CC BY 4.0
sourceDescriptions:
- name: lineItemsApi
url: ../openapi/commerce-layer-line-items-api-openapi.yml
type: openapi
- name: ordersApi
url: ../openapi/commerce-layer-orders-api-openapi.yml
type: openapi
workflows:
- workflowId: create-order-add-line-item
summary: Create an order, add a SKU line item, and read the order back.
description: >-
Creates a draft order in the supplied market, adds a single SKU line item
referencing the order, and retrieves the order to expose its totals.
inputs:
type: object
required:
- accessToken
- marketId
- skuCode
- quantity
properties:
accessToken:
type: string
description: Bearer access token for the Commerce Layer organization.
marketId:
type: string
description: The id of the market the order belongs to.
skuCode:
type: string
description: The SKU code to add as a line item.
quantity:
type: integer
description: The quantity of the SKU to add.
steps:
- stepId: createOrder
description: Create a draft order associated to the supplied market.
operationId: POST/orders
parameters:
- name: Authorization
in: header
value: "Bearer $inputs.accessToken"
requestBody:
contentType: application/vnd.api+json
payload:
data:
type: orders
relationships:
market:
data:
type: markets
id: $inputs.marketId
successCriteria:
- condition: $statusCode == 201
outputs:
orderId: $response.body#/data/id
- stepId: addLineItem
description: Add a SKU line item to the order using the SKU code and quantity.
operationId: POST/line_items
parameters:
- name: Authorization
in: header
value: "Bearer $inputs.accessToken"
requestBody:
contentType: application/vnd.api+json
payload:
data:
type: line_items
attributes:
sku_code: $inputs.skuCode
quantity: $inputs.quantity
relationships:
order:
data:
type: orders
id: $steps.createOrder.outputs.orderId
successCriteria:
- condition: $statusCode == 201
outputs:
lineItemId: $response.body#/data/id
- stepId: getOrder
description: Retrieve the order to read back its recalculated totals.
operationId: GET/orders/orderId
parameters:
- name: Authorization
in: header
value: "Bearer $inputs.accessToken"
- name: orderId
in: path
value: $steps.createOrder.outputs.orderId
successCriteria:
- condition: $statusCode == 200
outputs:
status: $response.body#/data/attributes/status
skusCount: $response.body#/data/attributes/skus_count
totalAmountCents: $response.body#/data/attributes/total_amount_cents
outputs:
orderId: $steps.createOrder.outputs.orderId
lineItemId: $steps.addLineItem.outputs.lineItemId
totalAmountCents: $steps.getOrder.outputs.totalAmountCents
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.