Skip to main content
POST
/
shipments
/
inventory-transfer
/
search
cURL
curl --request POST \
  --url https://api.fabric.inc/v3/shipments/inventory-transfer/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": "transferShipment.shipmentNum",
      "value": "Shipment_112255"
    },
    {
      "condition": "IN",
      "field": "transferShipment.cartons.cartonNum",
      "values": [
        "Tracking_*"
      ]
    }
  ],
  "sort": "-transferShipment.shipDate"
}
'
{
  "data": [
    {
      "shipFrom": {
        "locationNumber": "WH334",
        "locationName": "Store1",
        "locationType": "STORE",
        "shipFromAddress": {
          "address1": "House No 129",
          "address2": "10 Downing Street",
          "address3": "Bakers Colony",
          "address4": "Near ABC School",
          "city": "Beaumont",
          "country": "USA",
          "email": "[email protected]",
          "latitude": 35.294952,
          "longitude": 32.294952,
          "name": {
            "first": "John",
            "last": "Doe",
            "middle": "M"
          },
          "phone": {
            "number": "+10612345678",
            "type": "MOBILE"
          },
          "postalCode": "77705",
          "state": "TX",
          "type": "residence"
        }
      },
      "shipTo": {
        "locationNumber": "WH334",
        "locationName": "Store1",
        "locationType": "STORE",
        "shipToAddress": {
          "addressLine1": "254 House number",
          "addressLine2": "888 Broadway",
          "addressLine3": "17th street",
          "addressLine4": "Pearl",
          "city": "New York",
          "country": "USA",
          "latitude": 134.13413,
          "longitude": 757.0435,
          "postalCode": "1003",
          "state": "NY",
          "type": "home"
        },
        "shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
      },
      "shipmentNumber": "78974156816152",
      "transferId": "112345678912340",
      "transferNumber": "112345678912340",
      "attributes": {
        "attribute1": "value"
      },
      "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": [
        {
          "attributes": {
            "attribute1": "value"
          },
          "cartonNumber": "1",
          "cartonType": "Package",
          "estimatedDeliveryDate": "2022-05-26T07:58:30.996Z",
          "estimatedShipmentDate": "2022-05-25T07:58:30.996Z",
          "items": [
            {
              "adjustments": [
                {
                  "adjustmentQuantity": 2,
                  "attributes": {
                    "attribute1": "value"
                  },
                  "reasonCode": "DAMAGED",
                  "subReasonCode": "DAMAGED"
                }
              ],
              "attributes": {
                "attribute1": "value"
              },
              "channelId": "12",
              "deliveredQuantity": 2,
              "itemId": "100023",
              "lineItemId": "1",
              "packedQuantity": 2,
              "quantityType": "INCREMENT",
              "receivedQuantity": 2,
              "segment": "<string>",
              "shipmentLineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
              "shippedQuantity": 2,
              "sku": "SKU0023",
              "stockedQuantity": 2,
              "uom": "EA",
              "vendorId": "vend12346667"
            }
          ],
          "promisedDeliveryDate": "2022-05-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 gram"
        }
      ],
      "createdAt": "2022-06-06T07:58:30.996Z",
      "deliveredAt": "2022-06-06T07:58:30.996Z",
      "masterTrackingNumber": "TX112345678",
      "poNumber": "1125",
      "receivedAt": "2022-06-06T07:58:30.996Z",
      "recipient": [
        {
          "email": "[email protected]",
          "name": {
            "firstName": "Alex",
            "lastName": "Doe",
            "middleName": "E"
          },
          "phone": {
            "number": "123-456-7890",
            "type": "MOBILE"
          }
        }
      ],
      "shipmentId": "627963716b19511e8a3a631b",
      "shippedAt": "2022-06-06T07:58:30.996Z",
      "statusCode": "TRANSFER_SHIPMENT_CREATED",
      "stockReleaseTimeStamp": "2022-06-06T07:58:30.996Z",
      "subtype": "COD",
      "totalCartons": 2,
      "type": "TRANSFER",
      "updatedAt": "2022-06-06T07:58:30.996Z",
      "vendorId": "56"
    }
  ],
  "pagination": {
    "count": 1000,
    "limit": 10,
    "offset": 1
  },
  "stats": [
    "<string>"
  ]
}

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

Body

application/json

An object containing the sort and filter criteria for a transfer shipment search.

​
filters
object[]
required
Required array length: 1 - 50 elements

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.

​
sort
string
default:-transferShipment.shipDate

Property name on which response needed to be sorted.

Note: - refers to descending and + refers to ascending order

Example:

"-transferShipment.shipDate"

Response

OK

The search response.

​
data
object[]
​
pagination
object

Pagination response

​
stats
string[]

A list of stats.

The stats details.