POST /fulfillment-items.json

application/json

Body Required

costPrice number | null

Cost price
externalId string | null

External
fulfillmentId integer(int32) Required

Fulfillment
packed integer(int32) | null Required

Packed

Default value is 0.
picked integer(int32) | null Required

Picked

Default value is 0.
purchaseItemId integer(int32) | null

Purchase item
quantity integer(int32) Required

Quantity

Default value is 0.
saleItemId integer(int32) Required

Sale item
shipstationId string | null

Shipstation
skipInventoryChange boolean Required

Skip inventory change

Default value is false.
warehouseId integer(int32) Required

Warehouse
xeroId string | null

Xero

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- costPrice number | null
  
  Cost price
- createdAt string(date-time)
  
  Created at
- externalId string | null
  
  External
- fulfillmentId integer(int32) Required
  
  Fulfillment
- id integer(int32)
  
  Id
- packed integer(int32) | null Required
  
  Packed
  
  Default value is 0.
- picked integer(int32) | null Required
  
  Picked
  
  Default value is 0.
- purchaseItemId integer(int32) | null
  
  Purchase item
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 0.
- saleItemId integer(int32) Required
  
  Sale item
- shipstationId string | null
  
  Shipstation
- skipInventoryChange boolean Required
  
  Skip inventory change
  
  Default value is false.
- updatedAt string(date-time)
  
  Updated at
- warehouseId integer(int32) Required
  
  Warehouse
- xeroId string | null
  
  Xero

POST /fulfillment-items.json

curl \
 --request POST 'http://api.example.com/v1/fulfillment-items.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"costPrice":42.0,"externalId":"string","fulfillmentId":42,"packed":0,"picked":0,"purchaseItemId":42,"quantity":0,"saleItemId":42,"shipstationId":"string","skipInventoryChange":false,"warehouseId":42,"xeroId":"string"}'

Request examples

{
  "costPrice": 42.0,
  "externalId": "string",
  "fulfillmentId": 42,
  "packed": 0,
  "picked": 0,
  "purchaseItemId": 42,
  "quantity": 0,
  "saleItemId": 42,
  "shipstationId": "string",
  "skipInventoryChange": false,
  "warehouseId": 42,
  "xeroId": "string"
}

Response examples (200)

{
  "costPrice": 42.0,
  "createdAt": "2025-05-04T09:42:00Z",
  "externalId": "string",
  "fulfillmentId": 42,
  "id": 42,
  "packed": 0,
  "picked": 0,
  "purchaseItemId": 42,
  "quantity": 0,
  "saleItemId": 42,
  "shipstationId": "string",
  "skipInventoryChange": false,
  "updatedAt": "2025-05-04T09:42:00Z",
  "warehouseId": 42,
  "xeroId": "string"
}