POST
/
orchestrator
/
carts
/
{cartId}
/
order-drafts
curl --request POST \
  --url https://api.fabric.inc/v3/orchestrator/carts/{cartId}/order-drafts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "orderSequence": {
    "sequenceName": "STORE_ORDER_NUMBER",
    "sequenceKey": "SHOPZ"
  },
  "orderNumber": "SHOPZ0000001"
}'
{
  "order": {
    "id": "6d65755f-b1d9-4c9d-bb5b-118d317f8db4",
    "number": "100001",
    "lineItems": [
      {
        "id": "6d65755f-b1d9-4c9d-bb5b-118d317f8db4",
        "supplementaryData": {
          "productTitle": "Lamp"
        }
      }
    ],
    "attributes": {
      "orderStatus": "ACTIVE"
    }
  },
  "cartId": "4ed2e918-fb5b-47ed-bca3-da514b6aa6bf",
  "attributes": {},
  "customerContext": {
    "id": "109840938",
    "segments": [
      {
        "name": "membership",
        "value": [
          "gold",
          "silver"
        ]
      }
    ],
    "attributes": {
      "email": "test@gmail.com"
    },
    "sessionId": "3a5fd2d3-5c96-4e57-b069-7ff2a88c1119"
  },
  "status": "ACTIVE",
  "state": [
    {
      "resource": "CART",
      "resourceId": "c86f777b-1885-4ddf-961d-542ba80a69b8",
      "key": "MISSING_PAYMENT_DETAILS",
      "description": "No payment details have been added to this Cart"
    }
  ],
  "price": {
    "total": 1570,
    "subtotal": 1530,
    "tax": 0,
    "fulfillments": 40,
    "discounts": 0,
    "fees": 0,
    "adjustments": 0
  },
  "promotions": {
    "total": 0,
    "collection": [
      {
        "id": "6626c179627d450008a5b202",
        "title": "Cart Promotion Fixed Price",
        "type": "QUANTITY",
        "value": 10,
        "attributes": {
          "promotionStack": "HIGHEST"
        }
      }
    ]
  },
  "fees": {
    "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
    "name": "Eco Fee",
    "price": {
      "amount": 12.99
    },
    "taxable": true,
    "attributes": {
      "source": "eco"
    },
    "tax": {
      "total": 3,
      "collection": [
        {
          "amount": 3,
          "attributes": {
            "rate": "5.0",
            "type": "COUNTY"
          }
        }
      ]
    },
    "updatedAt": "2024-06-13T16:50:00.682Z",
    "createdAt": "2024-06-13T16:50:00.682Z",
    "taxDetails": {
      "destinationAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8",
      "originAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8"
    }
  },
  "adjustments": {
    "total": 2,
    "collection": [
      {
        "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
        "price": {
          "amount": 12.99
        },
        "reason": "Price adjustment from customer representative.",
        "attributes": {
          "source": "CSR"
        },
        "updatedAt": "2024-06-13T16:50:00.682Z",
        "createdAt": "2024-06-13T16:50:00.682Z"
      }
    ]
  },
  "addresses": {
    "a8577d7f0d4d4b228e857b4a2e90dc93": {
      "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
      "name": {
        "first": "John",
        "last": "Doe"
      },
      "email": "john@test.com",
      "phone": {
        "number": "1234567890",
        "type": "MOBILE"
      },
      "addressLine1": "123 Park Road",
      "addressLine2": "<string>",
      "addressLine3": "<string>",
      "addressLine4": "<string>",
      "city": "Santa Cruz",
      "region": "California",
      "country": "USA",
      "postalCode": "12345",
      "updatedAt": "2024-06-13T16:50:00.682Z",
      "createdAt": "2024-06-13T16:50:00.682Z"
    }
  },
  "lineItems": {
    "total": 100,
    "collection": [
      {
        "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
        "sku": "SKU3",
        "refId": "41",
        "quantity": 10,
        "priceListId": "10001",
        "position": 1,
        "price": {
          "unit": 10,
          "amount": 100
        },
        "fees": {
          "total": 5,
          "collection": [
            {
              "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
              "name": "Eco Fee",
              "price": {
                "amount": 12.99
              },
              "taxable": true,
              "attributes": {
                "source": "eco"
              },
              "tax": {
                "total": 3,
                "collection": [
                  {
                    "amount": 3,
                    "attributes": {
                      "rate": "5.0",
                      "type": "COUNTY"
                    }
                  }
                ]
              },
              "updatedAt": "2024-06-13T16:50:00.682Z",
              "createdAt": "2024-06-13T16:50:00.682Z",
              "taxDetails": {
                "destinationAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8",
                "originAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8"
              }
            }
          ]
        },
        "promotions": {
          "total": 2,
          "collection": [
            {
              "id": "bb44db95-6fbd-4eed-a1ed-4d99bc91250f",
              "amount": 15,
              "quantity": 3,
              "proration": {
                "spread": [
                  {
                    "amount": 5,
                    "quantity": 3
                  }
                ]
              }
            }
          ]
        },
        "adjustments": {
          "total": 2,
          "collection": [
            {
              "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
              "price": {
                "amount": 12.99
              },
              "reason": "Price adjustment from customer representative.",
              "attributes": {
                "source": "CSR"
              },
              "updatedAt": "2024-06-13T16:50:00.682Z",
              "createdAt": "2024-06-13T16:50:00.682Z"
            }
          ]
        },
        "fulfillment": {
          "id": "6d65755f-b1d9-4c9d-bb5b-118d317f8db4",
          "price": {
            "amount": 12.99
          },
          "inventory": {
            "channels": {
              "type": "WEB_PICKUP",
              "locationNumber": "15",
              "channelId": "12",
              "networkCode": "shipToHome"
            },
            "type": "availableToPurchase"
          },
          "tax": {
            "total": 3,
            "collection": [
              {
                "amount": 3,
                "attributes": {
                  "rate": "5.0",
                  "type": "COUNTY"
                }
              }
            ]
          }
        },
        "attributes": {
          "name": "item-custom"
        },
        "tax": {
          "total": 3,
          "collection": [
            {
              "amount": 3,
              "attributes": {
                "rate": "5.0",
                "type": "COUNTY"
              }
            }
          ]
        },
        "taxCode": "10001",
        "updatedAt": "2024-06-13T16:50:00.682Z",
        "createdAt": "2024-06-13T16:50:00.682Z"
      }
    ]
  },
  "fulfillments": {
    "d6229cdb0c5b4885b1b213b94d02488e": {
      "id": "d6229cdb-0c5b-4885-b1b2-13b94d02488e",
      "type": "SHIP_TO",
      "refId": "398427903843",
      "attributes": {
        "source": "store"
      },
      "originAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
      "destinationAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
      "locationId": "CA",
      "pickupPerson": {
        "primary": {
          "name": {
            "first": "John",
            "last": "Doe"
          },
          "email": "john@test.com",
          "phone": {
            "number": "1234567890",
            "type": "MOBILE"
          }
        },
        "secondary": [
          {
            "name": {
              "first": "John",
              "last": "Doe"
            },
            "email": "john@test.com",
            "phone": {
              "number": "1234567890",
              "type": "MOBILE"
            }
          }
        ]
      },
      "price": {
        "amount": 12.99
      },
      "promotions": {
        "total": 15,
        "collection": [
          {
            "id": "bb44db95-6fbd-4eed-a1ed-4d99bc91250f",
            "amount": 15
          }
        ]
      },
      "fees": {
        "total": 5,
        "collection": [
          {
            "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
            "name": "Eco Fee",
            "price": {
              "amount": 12.99
            },
            "taxable": true,
            "attributes": {
              "source": "eco"
            },
            "tax": {
              "total": 3,
              "collection": [
                {
                  "amount": 3,
                  "attributes": {
                    "rate": "5.0",
                    "type": "COUNTY"
                  }
                }
              ]
            },
            "updatedAt": "2024-06-13T16:50:00.682Z",
            "createdAt": "2024-06-13T16:50:00.682Z",
            "taxDetails": {
              "destinationAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8",
              "originAddress": "c86f777b-1885-4ddf-961d-542ba80a69b8"
            }
          }
        ]
      },
      "adjustments": {
        "total": 2,
        "collection": [
          {
            "id": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
            "price": {
              "amount": 12.99
            },
            "reason": "Price adjustment from customer representative.",
            "attributes": {
              "source": "CSR"
            },
            "updatedAt": "2024-06-13T16:50:00.682Z",
            "createdAt": "2024-06-13T16:50:00.682Z"
          }
        ]
      },
      "tax": {
        "total": 3,
        "collection": [
          {
            "amount": 3,
            "attributes": {
              "rate": "5.0",
              "type": "COUNTY"
            }
          }
        ]
      }
    }
  },
  "coupons": [
    {
      "code": "VALID_COUPON",
      "updatedAt": "2024-06-13T16:50:00.682Z"
    }
  ],
  "appliedCoupons": [
    {
      "code": "VALID_COUPON",
      "updatedAt": "2024-06-13T16:50:00.682Z"
    }
  ],
  "notAppliedCoupons": [
    {
      "code": "VALID_COUPON",
      "updatedAt": "2024-06-13T16:50:00.682Z"
    }
  ],
  "payments": {
    "authorized": 800,
    "collection": [
      {
        "id": "6ef2067a-5d6b-4785-a090-96ea0078220d",
        "provider": "verifone",
        "processor": "stripe",
        "method": "apple pay",
        "methodType": "credit card",
        "state": "PENDING",
        "authorization": {
          "amount": 8,
          "expiry": "2024-06-13T16:50:00.682Z",
          "verifier": {
            "type": "TOKEN",
            "key": "CH39082K439R0"
          }
        },
        "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
        "cardDetails": {},
        "attributes": {
          "gift-card-name": "custom name"
        }
      }
    ]
  },
  "updatedAt": "2024-06-24T16:57:47.112Z",
  "createdAt": "2024-06-24T16:56:43.027Z",
  "errors": [
    {
      "code": "ERR001",
      "message": "Invalid input"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Include the Bearer<token> header where the <token> is the authentication token generated from the Getting Started with fabric APIs process.

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-request-id
string

Unique request ID for tracking.

​
x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

Path Parameters

​
cartId
string
required

The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.

Body

application/json

Order draft request body

​
orderSequence
object

An order sequence is used to define a pattern or template for generating unique order numbers. This object contains the order sequence name and identifier.

​
orderNumber
string

Order number based on the order sequence.

Example:

"SHOPZ0000001"

Response

200
application/json

Order draft created successfully

​
order
object

Order information

​
cartId
string

The unique identifier of the cart that was passed in the parameter.

Example:

"4ed2e918-fb5b-47ed-bca3-da514b6aa6bf"

​
attributes
object

Custom attributes used to describe the cart, such as a wishlist cart.

​
customerContext
object

Customer context object containing customer information.

​
status
enum<string>

The cart status indicates whether the cart is active or deleted.

Available options:
ACTIVE,
SOFT_DELETE
Example:

"ACTIVE"

​
state
object[]

The resource state is stored in an array that holds information about the current status of the cart.

​
price
object

The sum of the total amount of the cart.

​
promotions
object

A collection of promotions applied to the cart.

​
fees
object

A collection of fees associated with the cart.

​
adjustments
object

A collection of adjustments made to the cart.

​
addresses
object

A map of addresses added to the cart.

​
lineItems
object

A collection of items in the cart.

​
fulfillments
object

A map of fulfillments added to the cart.

​
coupons
object[]

An array containing all coupons added to the cart.

​
appliedCoupons
object[]

An array containing all coupons applied to the cart.

​
notAppliedCoupons
object[]

An array containing any coupons that were ineligible and not applied to the cart.

​
payments
object

An object containing a collection of payments added to the cart.

​
updatedAt
string

The date and time in UTC when the cart was last updated.

Example:

"2024-06-24T16:57:47.112Z"

​
createdAt
string

The date and time when a cart was created.

Example:

"2024-06-24T16:56:43.027Z"

​
errors
object[]