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
Inventory transfer search
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
An object containing the sort and filter criteria for a transfer shipment search.
Property name on which response needed to be sorted. <p> 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
Body
An object containing the sort and filter criteria for a transfer 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. <p> Note: - refers to descending and + refers to ascending order
Response
The search response.
Attributes to save any additional info
Attributes to save any additional info
Audit logs list
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 list
Attributes to save any additional info
Attributes to save any additional info
Carton number
Carton type
Estimated delivery date
Estimated ship date
List of item to be shipped
Adjustment
The total adjustment quantity. The default value is 0.
Attributes to save any additional info
The primary reason code for the item adjustment.
The sub reason code for the item adjustment.
Customized attributes
Customized attributes
Channel id
Delivered quantity
Item id
Line item ID
Packed quantity
Transfer quantity type
INCREMENT, DECREMENT, ABSOLUTE Received quantity
Segment
System generated shipment line item ID
Shipped quantity
Sku
Stocked quantity
Unit of measurement
Vendor ID
Promised delivery date
Shipment carrier
Shipment method
Tracking detail list
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
Tracking number
Tracking URL
Weight
Created date
Delivered date of shipment
Master tracking number
Optional purchase order number
Received date of shipment
Recipient list
Recipient's email
An object containing information and properties for the transfers ship from location.
Location number
Location name
Location type
Order address model
The first address line.
The second address line.
The third address line.
The fourth address line.
City
Country
A valid email address.
Latitude
Longitude
Postal code
State
The type of address provided. For example, home or residence.
An object containing information and properties for the transfers ship to location.
Location number
Location name
Location type
ShipmentShipToAddress Model
Address line 1
Address line 2
Address line 3
Address line 4
City
Country
Latitude
Longitude
Postal code
State
The type of address that was provided.
Used to link item with it's shipping address in shipment
Shipment's autogenerated unique id
Shipment's unique identification number
Ship date
Transfer Shipment Status
TRANSFER_SHIPMENT_PACKED, TRANSFER_SHIPMENT_SENT, TRANSFER_SHIPMENT_CREATED, TRANSFER_SHIPMENT_DRAFT, TRANSFER_SHIPMENT_DELIVERED, TRANSFER_SHIPMENT_RECEIVED, TRANSFER_SHIPMENT_STOCKED, TRANSFER_SHIPMENT_CANCELLED, TRANSFER_SHIPMENT_ERROR Stock release time stamp date
Shipment subtype
COD Total number of cartons
Transfer ID for this shipment
Transfer number for this shipment
Shipment types
STANDARD, RESHIP, RETURN, SCRATCH, PENDING_RETURN, PICKUP, TRANSFER Updated date
Vendor ID
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 > 0A list of stats.
Was this page helpful?