Skip to main content
POST
/
shipments
/
search
Find shipments
curl --request POST \
  --url https://api.fabric.inc/v3/shipments/search \
  --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 '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "shipment.shipmentNum",
      "value": "Shipment_112255"
    },
    {
      "condition": "IN",
      "field": "shipment.cartons.cartonNum",
      "values": [
        "Tracking_*"
      ]
    }
  ],
  "sort": "-shipment.shipDate"
}
'
{
  "data": [
    {
      "version": 2,
      "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,
                  "amountInCurrencies": [
                    {
                      "currency": "USD",
                      "group": "SHOPPER",
                      "amount": 123.45
                    }
                  ],
                  "name": "RETURN_FEE",
                  "reason": "Return fee",
                  "type": "FEE"
                }
              ],
              "giftCards": [
                {
                  "amount": 50,
                  "amountInCurrencies": [
                    {
                      "currency": "USD",
                      "group": "SHOPPER",
                      "amount": 123.45
                    }
                  ],
                  "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,
              "refundAmountInCurrencies": [
                {
                  "currency": "USD",
                  "group": "SHOPPER",
                  "amount": 123.45
                }
              ],
              "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": "WH334",
      "locationType": "DC",
      "masterTrackingNumber": "TX112345678",
      "orderNumbers": [
        "309020213, 459020213"
      ],
      "poNumber": "1125",
      "recipients": [
        {
          "email": "[email protected]",
          "name": {
            "firstName": "Alex",
            "lastName": "Doe",
            "middleName": "E"
          },
          "phone": {
            "number": "123-456-7890",
            "type": "MOBILE"
          }
        }
      ],
      "reshipmentReasonCode": "Order is missing",
      "scratchedItems": [
        {
          "reasonCode": "ReasonCode23454",
          "itemId": 100043,
          "lineItemId": "2",
          "orderId": "6413e370cb0dc859b6c0dcb0",
          "quantity": 1,
          "sku": "SKU00043",
          "subReasonCode": "SubReasonCode23242",
          "uom": "EA"
        }
      ],
      "shipToAddress": {
        "addressLine1": "123 Main St.",
        "city": "Seattle",
        "countryCode": "US",
        "latitude": 47.6205,
        "longitude": -122.3493,
        "postalCode": "98121",
        "region": "WA",
        "type": "Home",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "email": "[email protected]",
        "name": {
          "firstName": "Alex",
          "lastName": "Doe",
          "middleName": "E"
        },
        "phone": {
          "number": "123-456-7890",
          "type": "MOBILE"
        }
      },
      "shipToId": "1",
      "shipmentId": "627963716b19511e8a3a631b",
      "shipmentNumber": "78974156816152",
      "shipmentExternalId": "123k4h123k",
      "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"
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  }
}

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

Query Parameters

​
fetchOnlyIds
boolean
default:false
​
offset
number
default:0

The number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

​
limit
number
default:10

Maximum number of records per page.

Example:

10

Body

application/json

Sort and filter criteria for shipment search

​
filters
object[]
required
Maximum array length: 50

The criteria used to find shipments by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used. Criteria to find shipments. To search using a single value, the valueSearchFilter is considered. To search using multiple values, valuesSearchFilter is considered.

​
sort
string
default:-shipment.shipDate

Property name on which response needed to be sorted. Note: - refers to descending and + refers to ascending order

Example:

"-shipment.shipDate"

Response

OK

Shipment search response

​
data
object[]
​
pagination
object

Pagination response