Create new shipment

To use this endpoint an “allocation” must exist for the order that’s being shipped. When an order is placed, fabric sends allocation details to external merchant system to create order fulfillment requirement details in an external system. With reference to the allocation that’s being shipped, users of this POST API can create shipment details for allocations.

Note: Shipment ID generated as part of the response is required for subsequent calls such as Acknowledge shipment (POST /shipments/{shipmentId}/acknowledge) and Get shipment (GET /shipments/{shipmentId}).

POST

shipments

curl --request POST \
  --url https://api.fabric.inc/v3/shipments \
  --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 '{
  "allocationId": "112345678912340",
  "attributes": {
    "attribute1": "value"
  },
  "cartons": [
    {
      "cartonNumber": "1",
      "cartonType": "Package",
      "estimatedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "estimatedShipDate": "2023-03-25T07:58:30.996Z",
      "items": [
        {
          "attributes": {
            "attribute1": "value"
          },
          "fees": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "giftCards": [
            {
              "amount": 50,
              "giftCardNumber": "453456765"
            }
          ],
          "itemId": 100023,
          "lineItemId": "1",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "orderNumber": "309020213",
          "orderedQuantity": 2,
          "refundAmount": 10,
          "returnQuantity": 1,
          "returnRequestCounter": 1,
          "segment": "segment",
          "shippedQuantity": 2,
          "sku": "SKU0023",
          "uom": "EA",
          "vendorId": "56"
        }
      ],
      "promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "shipmentCarrier": "FEDEX",
      "shipmentMethod": "ground",
      "tracking": [
        {
          "event": "picked up",
          "eventId": "627963716b19511e8a3a631b",
          "eventRecordedAt": "2019-09-30T07:58:30.996Z",
          "location": "Reno, NV",
          "notes": {
            "description": "Shipment picked up"
          },
          "shipmentCarrier": "FEDEX"
        }
      ],
      "trackingNumber": "1Z999AA10123456784",
      "trackingURL": "https://fedex.com/tracking",
      "weight": "500 gram"
    }
  ],
  "invoiceId": "63ef4360aafa8a7f5247fe48",
  "locationNumber": "132412",
  "locationType": "DC",
  "masterTrackingNumber": "TX112345678",
  "poNumber": "1125",
  "recipients": [
    {
      "email": "support@example.inc",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      }
    }
  ],
  "reshipmentReasonCode": "Order is missing",
  "scratchedItems": [
    {
      "attributes": {
        "attribute1": "value"
      },
      "itemId": 100043,
      "lineItemId": "2",
      "quantity": 1,
      "reasonCode": "ReasonCode23454",
      "sku": "SKU00043",
      "subReasonCode": "SubReasonCode23242",
      "uom": "EA"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "countryCode": "US",
    "email": "test@example.com",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "shipToId": "sg6683620405",
  "shipmentId": "627963716b19511e8a3a631b",
  "shipmentNumber": "78974156816152",
  "shippedAt": "2023-04-06T07:58:30.996Z",
  "statusCode": "SHIPMENT_CREATED",
  "subtype": "COD",
  "totalCartons": 2,
  "type": "STANDARD",
  "vendorId": "56"
}'

{
  "allocationId": "6413e3d3fd03a35efccb426e",
  "auditLogs": [
    {
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "employeeId": "6227",
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "note": "Note",
      "reasonCode": "Scratched item",
      "source": "POS",
      "subReasonCode": "Scratched item",
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ]
    }
  ],
  "cartons": [
    {
      "cartonNumber": "1",
      "cartonType": "Package",
      "estimatedDeliveryDate": "2023-04-26T07:58:30.996Z",
      "estimatedShipmentDate": "2023-03-25T07:58:30.996Z",
      "items": [
        {
          "fees": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "giftCards": [
            {
              "amount": 50,
              "giftCardActivatedAt": "2023-04-26T07:58:30.996Z",
              "giftCardActivationRequestedAt": "2023-03-26T07:58:30.996Z",
              "giftCardNumber": "453456765",
              "giftCardStatus": "ACTIVE"
            }
          ],
          "itemId": 100023,
          "lineItemId": "1",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "orderNumber": "309020213",
          "orderedQuantity": 2,
          "refundAmount": 10,
          "returnQuantity": 1,
          "segment": "segment",
          "shipmentLineItemId": "607f1f77bcf86cd799439011",
          "shippedQuantity": 2,
          "sku": "SKU0023",
          "uom": "EA",
          "vendorId": "vend12346667"
        }
      ],
      "promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "shipmentCarrier": "FEDEX",
      "shipmentMethod": "ground",
      "tracking": [
        {
          "event": "picked up",
          "eventId": "627963716b19511e8a3a631b",
          "eventRecordedAt": "2019-09-30T07:58:30.996Z",
          "location": "Reno, NV",
          "notes": {
            "description": "Shipment picked up"
          },
          "shipmentCarrier": "FEDEX"
        }
      ],
      "trackingNumber": "1Z999AA10123456784",
      "trackingURL": "https://example.com/tracking",
      "weight": "500 grams"
    }
  ],
  "createdAt": "2023-04-06T07:58:30.996Z",
  "invoiceId": "63ef4360aafa8a7f5247fe48",
  "locationNumber": "132412",
  "locationType": "DC",
  "masterTrackingNumber": "TX112345678",
  "orderNumbers": [
    "309020213, 459020213"
  ],
  "poNumber": "1125",
  "recipients": [
    {
      "email": "support@example.inc",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      }
    }
  ],
  "reshipmentReasonCode": "Order is missing",
  "scratchedItems": [
    {
      "itemId": 100043,
      "lineItemId": "2",
      "orderId": "6413e370cb0dc859b6c0dcb0",
      "quantity": 1,
      "reasonCode": "ReasonCode23454",
      "sku": "SKU00043",
      "subReasonCode": "SubReasonCode23242",
      "uom": "EA"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "countryCode": "US",
    "email": "test@example.com",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "shipToId": "1",
  "shipmentId": "627963716b19511e8a3a631b",
  "shipmentNumber": "78974156816152",
  "shippedAt": "2023-04-06T07:58:30.996Z",
  "statusCode": "SHIPMENT_CREATED",
  "subtype": "COD",
  "totalCartons": 2,
  "type": "STANDARD",
  "updatedAt": "2023-04-06T07:58:30.996Z",
  "vendorId": "56",
  "version": 2
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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-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.

x-fabric-request-id

string

Unique request ID

Body

application/json

Details to create shipment

Response

201

application/json

Created

Shipment details

Getting Started with Shipments Get shipment by ID

curl --request POST \
  --url https://api.fabric.inc/v3/shipments \
  --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 '{
  "allocationId": "112345678912340",
  "attributes": {
    "attribute1": "value"
  },
  "cartons": [
    {
      "cartonNumber": "1",
      "cartonType": "Package",
      "estimatedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "estimatedShipDate": "2023-03-25T07:58:30.996Z",
      "items": [
        {
          "attributes": {
            "attribute1": "value"
          },
          "fees": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "giftCards": [
            {
              "amount": 50,
              "giftCardNumber": "453456765"
            }
          ],
          "itemId": 100023,
          "lineItemId": "1",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "orderNumber": "309020213",
          "orderedQuantity": 2,
          "refundAmount": 10,
          "returnQuantity": 1,
          "returnRequestCounter": 1,
          "segment": "segment",
          "shippedQuantity": 2,
          "sku": "SKU0023",
          "uom": "EA",
          "vendorId": "56"
        }
      ],
      "promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "shipmentCarrier": "FEDEX",
      "shipmentMethod": "ground",
      "tracking": [
        {
          "event": "picked up",
          "eventId": "627963716b19511e8a3a631b",
          "eventRecordedAt": "2019-09-30T07:58:30.996Z",
          "location": "Reno, NV",
          "notes": {
            "description": "Shipment picked up"
          },
          "shipmentCarrier": "FEDEX"
        }
      ],
      "trackingNumber": "1Z999AA10123456784",
      "trackingURL": "https://fedex.com/tracking",
      "weight": "500 gram"
    }
  ],
  "invoiceId": "63ef4360aafa8a7f5247fe48",
  "locationNumber": "132412",
  "locationType": "DC",
  "masterTrackingNumber": "TX112345678",
  "poNumber": "1125",
  "recipients": [
    {
      "email": "support@example.inc",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      }
    }
  ],
  "reshipmentReasonCode": "Order is missing",
  "scratchedItems": [
    {
      "attributes": {
        "attribute1": "value"
      },
      "itemId": 100043,
      "lineItemId": "2",
      "quantity": 1,
      "reasonCode": "ReasonCode23454",
      "sku": "SKU00043",
      "subReasonCode": "SubReasonCode23242",
      "uom": "EA"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "countryCode": "US",
    "email": "test@example.com",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "shipToId": "sg6683620405",
  "shipmentId": "627963716b19511e8a3a631b",
  "shipmentNumber": "78974156816152",
  "shippedAt": "2023-04-06T07:58:30.996Z",
  "statusCode": "SHIPMENT_CREATED",
  "subtype": "COD",
  "totalCartons": 2,
  "type": "STANDARD",
  "vendorId": "56"
}'

{
  "allocationId": "6413e3d3fd03a35efccb426e",
  "auditLogs": [
    {
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "employeeId": "6227",
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "note": "Note",
      "reasonCode": "Scratched item",
      "source": "POS",
      "subReasonCode": "Scratched item",
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ]
    }
  ],
  "cartons": [
    {
      "cartonNumber": "1",
      "cartonType": "Package",
      "estimatedDeliveryDate": "2023-04-26T07:58:30.996Z",
      "estimatedShipmentDate": "2023-03-25T07:58:30.996Z",
      "items": [
        {
          "fees": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "giftCards": [
            {
              "amount": 50,
              "giftCardActivatedAt": "2023-04-26T07:58:30.996Z",
              "giftCardActivationRequestedAt": "2023-03-26T07:58:30.996Z",
              "giftCardNumber": "453456765",
              "giftCardStatus": "ACTIVE"
            }
          ],
          "itemId": 100023,
          "lineItemId": "1",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "orderNumber": "309020213",
          "orderedQuantity": 2,
          "refundAmount": 10,
          "returnQuantity": 1,
          "segment": "segment",
          "shipmentLineItemId": "607f1f77bcf86cd799439011",
          "shippedQuantity": 2,
          "sku": "SKU0023",
          "uom": "EA",
          "vendorId": "vend12346667"
        }
      ],
      "promisedDeliveryDate": "2023-03-26T07:58:30.996Z",
      "shipmentCarrier": "FEDEX",
      "shipmentMethod": "ground",
      "tracking": [
        {
          "event": "picked up",
          "eventId": "627963716b19511e8a3a631b",
          "eventRecordedAt": "2019-09-30T07:58:30.996Z",
          "location": "Reno, NV",
          "notes": {
            "description": "Shipment picked up"
          },
          "shipmentCarrier": "FEDEX"
        }
      ],
      "trackingNumber": "1Z999AA10123456784",
      "trackingURL": "https://example.com/tracking",
      "weight": "500 grams"
    }
  ],
  "createdAt": "2023-04-06T07:58:30.996Z",
  "invoiceId": "63ef4360aafa8a7f5247fe48",
  "locationNumber": "132412",
  "locationType": "DC",
  "masterTrackingNumber": "TX112345678",
  "orderNumbers": [
    "309020213, 459020213"
  ],
  "poNumber": "1125",
  "recipients": [
    {
      "email": "support@example.inc",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      }
    }
  ],
  "reshipmentReasonCode": "Order is missing",
  "scratchedItems": [
    {
      "itemId": 100043,
      "lineItemId": "2",
      "orderId": "6413e370cb0dc859b6c0dcb0",
      "quantity": 1,
      "reasonCode": "ReasonCode23454",
      "sku": "SKU00043",
      "subReasonCode": "SubReasonCode23242",
      "uom": "EA"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "city": "Seattle",
    "countryCode": "US",
    "email": "test@example.com",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "postalCode": "98121",
    "region": "WA",
    "type": "Home"
  },
  "shipToId": "1",
  "shipmentId": "627963716b19511e8a3a631b",
  "shipmentNumber": "78974156816152",
  "shippedAt": "2023-04-06T07:58:30.996Z",
  "statusCode": "SHIPMENT_CREATED",
  "subtype": "COD",
  "totalCartons": 2,
  "type": "STANDARD",
  "updatedAt": "2023-04-06T07:58:30.996Z",
  "vendorId": "56",
  "version": 2
}