Create Fulfillment

POST /commerce/orders/:orderId/fulfillments

Create a fulfillment for an order for a specified user

Request

Path Parameters

orderId stringrequired

The order ID of the fulfillment

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

application/json

Body

carrier string

Carrier company, ex "USPS", "Fedex", "UPS", "Canada Post", etc. Can be any string.

service string

The type of service used for shipping.

trackingUrls string[]

An array of tracking URLs associated with the fulfillment.

trackingNumbers string[]

An array of tracking numbers associated with the fulfillment.

lineItems

object[]

An array of line items associated with the fulfillment.

Array [

quantity int32

The quantity of the line item.

lineItemId string

The unique identifier for the line item.

price int32

The price of the line item.

title string

The title or name of the line item.

sku string

The SKU (stock-keeping unit) of the line item.

productId string

The unique identifier for the product.

variantId string

The unique identifier for the product variant.

]

remoteFields json

An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses

200

application/json

Schema
Result

Schema

any

{
  "fulfillment": [
    {
      "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
      "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
      "remoteDeleted": false,
      "createdAt": "2024-02-22T11:17:53.264Z",
      "updatedAt": "2024-02-22T13:54:03.445Z",
      "orderId": "0acf204e-62cc-4840-9f0a-b227f97e5613",
      "trackingNumbers": [],
      "trackingUrls": [],
      "lineItems": [
        {
          "quantity": 1,
          "productId": "7892548747520",
          "lineItemId": "12561932648704",
          "price": "2.00",
          "variantId": "43101260415232",
          "title": "Dev Hoodie",
          "sku": ""
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000"
    }
}

400

application/json

Schema
Example (from schema)
Result

Schema

object

{}

{}