POST /fulfillments.json

POST /fulfillments.json
application/json

Body Required

Responses

POST /fulfillments.json
curl \
 -X POST http://api.example.com/v1/fulfillments.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"adminNotes":"string","aftershipId":"string","channelAttempts":0,"channelError":true,"channelNotification":"trigger","commercialInvoiceUrl":"string","days":42,"durationTerms":"string","externalId":"string","files":{},"fulfillmentType":"manual","grams":0,"intercomMessageId":"string","inventoryStatus":"notShipped","labelError":"string","labelFileFormat":"png","labelFiles":{},"labelRefund":false,"labelUrl":"string","manifestId":42,"muteError":false,"packed":false,"packedAt":"2024-05-04T09:42:00+00:00","picked":false,"pickedAt":"2024-05-04T09:42:00+00:00","price":0,"printedLabel":false,"printedLabelAt":"2024-05-04T09:42:00+00:00","provider":"string","quoteId":"string","reference":"string","requiresShippingApproval":"notRequired","saleId":42,"serviceLevel":"string","serviceLevelTerms":"string","shippedAt":"2024-05-04T09:42:00+00:00","shippoLabelIds":["string"],"shipstationId":"string","status":"finalized","tags":["string"],"trackingCompany":"string","trackingNumber":"string","trackingStatus":"delivered","trackingStatusDate":"2024-05-04T09:42:00+00:00","trackingStatusDetails":"string","trackingUrl":"string","userId":42,"xeroId":"string"}'
Request example
{
  "adminNotes": "string",
  "aftershipId": "string",
  "channelAttempts": 0,
  "channelError": true,
  "channelNotification": "trigger",
  "commercialInvoiceUrl": "string",
  "days": 42,
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "fulfillmentType": "manual",
  "grams": 0,
  "intercomMessageId": "string",
  "inventoryStatus": "notShipped",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUrl": "string",
  "manifestId": 42,
  "muteError": false,
  "packed": false,
  "packedAt": "2024-05-04T09:42:00+00:00",
  "picked": false,
  "pickedAt": "2024-05-04T09:42:00+00:00",
  "price": 0,
  "printedLabel": false,
  "printedLabelAt": "2024-05-04T09:42:00+00:00",
  "provider": "string",
  "quoteId": "string",
  "reference": "string",
  "requiresShippingApproval": "notRequired",
  "saleId": 42,
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippedAt": "2024-05-04T09:42:00+00:00",
  "shippoLabelIds": [
    "string"
  ],
  "shipstationId": "string",
  "status": "finalized",
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2024-05-04T09:42:00+00:00",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "userId": 42,
  "xeroId": "string"
}
Response examples (200)
{
  "adminNotes": "string",
  "aftershipId": "string",
  "channelAttempts": 0,
  "channelError": true,
  "channelNotification": "trigger",
  "commercialInvoiceUrl": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "days": 42,
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "fulfillmentType": "manual",
  "grams": 0,
  "id": 42,
  "intercomMessageId": "string",
  "inventoryStatus": "notShipped",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUrl": "string",
  "manifestId": 42,
  "muteError": false,
  "packed": false,
  "packedAt": "2024-05-04T09:42:00+00:00",
  "picked": false,
  "pickedAt": "2024-05-04T09:42:00+00:00",
  "price": 0,
  "printedLabel": false,
  "printedLabelAt": "2024-05-04T09:42:00+00:00",
  "provider": "string",
  "quoteId": "string",
  "reference": "string",
  "requiresShippingApproval": "notRequired",
  "saleId": 42,
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippedAt": "2024-05-04T09:42:00+00:00",
  "shippoLabelIds": [
    "string"
  ],
  "shipstationId": "string",
  "status": "finalized",
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2024-05-04T09:42:00+00:00",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "userId": 42,
  "xeroId": "string"
}