Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
- Webhook Events
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
- Customer Profile
- Customer Address
- Customer Self
Find shipments
As merchants, you may want to view shipments of specific statuses, monitor progress of deliveries, and proactively manage situations to ensure timely deliveries.
This endpoint enables you to easily search for shipments based on the specified criteria in the request body. You can refine your search by specifying limit and offset. When they’re not specified, by default you will get up to 10 records. In addition, you can sort results.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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 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.
Unique request ID
The number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page.
Sort and filter criteria for shipment search
Property name on which response needed to be sorted. Note: - refers to descending and + refers to ascending order
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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 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.
Unique request ID
Query Parameters
The number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page.
Body
Sort and filter criteria for shipment search
Filter conditions. EQ (Equal to): Searches for exact match. NEQ (Not equal to): Searches by excluding the specified value. IN: Search for multiple values. NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.
EQ, NEQ, IN, NIN, LT, GT, LTE, GTE Field name
Group name
Search criteria using a single value
Property name on which response needed to be sorted. Note: - refers to descending and + refers to ascending order
Response
Shipment search response
System-generated allocation ID (UUID) from the Create allocation endpoint of fabric Allocation service. It refers to the given shipment. Note: Allocation occurs prior to Shipment Creation. allocationId is mandatory to create a Shipment.
Audit log details
System-generated audit ID (UUID format)
Audit type such as cancel, return, etc.
Audit time (UTC)
Employee (ID or name) who made the last update
Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.
Additional info, if any
Merchant-defined reason code, varies from merchant to merchant
Merchant-defined source from where the update was initiated. There are no predefined values; possible values could be Customer Service Representative (CSR), Point-of-Sale (POS), etc.
Merchant-defined sub reason code; provides more clarity to audit reason
Carton details
Merchant-defined unique identifier. This can optionally be generated by fabric by using the resource generator feature of the Configuration service.
Carton type
Estimated delivery date given by carrier based on several factors including selected shipping method and delivery location (UTC).
Estimated ship date given by seller based on availability of items, their processing time, delivery location, and selected shipping method (UTC).
Carton item details
Gift card details
Gift card amount
Time gift card was activated (UTC)
Time of placing gift card activation request (UTC)
Gift card number
Gift card status
PENDING_ACTIVATION, ACTIVE, FAILED Unique item identifier
Unique number assigned by merchant to identify each item in an order. When this value isn't provided, fabric will auto generate (in UUID format) during order creation.
24-character order ID generated in the response of Create Order endpoint - POST /orders
Merchant-defined order identifier
Ordered quantity of given item
Refund amount for returned items
Returned quantity of given item
Item segment
Unique number assigned by merchant to identify item in a shipment. When this value isn't provided, fabric will auto generate it (UUID format) during shipment.
Shipped quantity of given item
Stock keeping unit (SKU), unique item identifier
Unit in which a product is measured or sold. UOM can be set to 'each' (EA) or GAL (Gallon), DZ (Dozen), etc.
Vendor ID. Applicable in dropshipping scenarios to indicate the vendor responsible for the given item.
Promised delivery date given by seller (UTC)
Shipment carrier name
Shipment method
Carton tracking details
Shipment-specific event. Mandatory in the request body of Update shipment tracking - POST /shipments/actions/update-tracking endpoint
Event ID provided by carrier
Time event was recorded (UTC)
Delivery location
Attributes to save any additional info
Attributes to save any additional info
Shipment carrier
Carton tracking number. There is a single tracking number per carton
Carton tracking URL
Carton weight
Shipment creation time (UTC)
Invoice ID generated from fabric Invoice service during shipment creation. Note: Invoices are only created for Shipments where merchants have payment Capture at Shipment feature enabled. The value will be “Null” if merchants don't have “Capture at Shipment” feature enabled.
Unique value to identify ship-from location. This must be the locationNumber stored in the fabric Location service.
Location type, such as distribution center (DC) or warehouse
Master tracking number for all cartons in the shipment
List of order numbers associated with a shipment. Note: Currently, a shipment can be associated with only one order. In the future, this property will support a scenario where a customer places a second order for the same product immediately after their first order. Multiple order numbers can be linked to one shipment in such cases.
Merchant-defined purchase order number
Recipient details
Recipient's email
The reshipment reason code.
Details of scratched items
Unique item identifier
Unique number assigned by merchant to identify each item in an order. When this value isn't provided, fabric will auto generate it (in UUID format) during order creation.
24-character ID displayed in the response of Create Order endpoint - POST /orders
Number of scratched items
Reason code for scratch
Stock keeping unit (SKU), unique item identifier
Sub-reason code
Unit in which a product is measured or sold. UOM can be set to 'each' (EA) or GAL (Gallon), DZ (Dozen), etc.
Address details
Address line 1
City name
ISO 3166-1 alpha-2 based country code
Address latitude, used with longitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -90 and 90, both inclusive.
Address longitude, used with latitude to specify the address location. Decimal degrees format; negative is degrees South. **Note:**Value must be between -180 and 180, both inclusive.
Postal or ZIP code
Region or state
Address type
Address line 2
Address line 3
Address line 4
Contact person's email
Ship-to ID generated in the response of Create shipping endpoint of Shipping service
System-generated shipment ID (UUID)
Merchant-defined unique shipment identifier. Note: It can be optionally generated by fabric by using resource generator feature in the Configuration service
Order shipment time (UTC)
Current shipment status (fabric-defined codes). Note: For standard shipments, the status would be SHIPMENT_CREATED. For pickup shipment, the initial status would be PICKUP_CREATED and once the customer picks up, the status changes to PICKUP_COMPLETED
SHIPMENT_CREATED, SHIPMENT_UPDATED, SHIPMENT_CANCELLED, PICKUP_CREATED, PICKUP_COMPLETED, SHIPMENT_DELIVERED, SHIPMENT_RETURN_PENDING, SHIPMENT_RETURN_RECEIVED, SHIPMENT_PARTIALLY_DELIVERED Shipment subtype, for another layer of classification. There are no pre-defined values; the possible value is Cash On Delivery (COD)
Total number of cartons in the given shipment. There can be only one carton per trackingNumber.
Shipment types
STANDARD, RESHIP, RETURN, SCRATCH, PENDING_RETURN, PICKUP, TRANSFER Time of last update to shipment (UTC)
Vendor ID. Applicable in dropshipping scenarios to indicate the vendor responsible for the given item.
The current version of the shipment document. This integer indicates the number of times the shipment has been updated by any operation.
Pagination response
Total number of search results
Maximum number of records per page.
1 < x < 100The number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.
x > 0Was this page helpful?