How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

fabric Shipments API

fabric **Shipments** API is a multi-tenant service that enables you to manage shipments for existing 'Allocations.' Shipments serve as records of the locations from which an order was fulfilled. Typical user of fabric Shipments service is a Warehouse management service or Point of Sale service. **Note**: Shipments API relies on the Allocation service to send allocation details to external merchant systems after an order is placed. Allocation is the prerequisite for using Shipments API.

fabric Shipments API is one of 61 APIs that fabric publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 9 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.fabric.inc/v3.

9 operations 9 paths 36 schemas 2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://{customer_name}.login.fabric.inc
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

fabric Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (authorization). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 2 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Shipments 9

fabric Shipments API is a multi-tenant service that enables you to manage shipments for existing 'Allocations.' Shipments serve as records of the locations from which an order was…

POST
/shipments
Create New Shipment
createShipment 3 params body → 201400401500
POST
/shipments/create-order-shipment
Create Shipment for an Existing Order
createShipmentByOrder 3 params body → 201400401500
POST
/shipments/actions/re-ship
Create Re-shipment
createReshipment 3 params body → 200400401500
POST
/shipments/actions/update-tracking
Update Shipment Tracking
updateTrackingDetails 3 params body → 200400401404500
POST
/shipments/search
Find Shipments
searchShipments 6 params body → 200400401500
GET
/shipments/{shipmentId}
Get Shipment by ID
getShipment 4 params → 200400401404500
GET
/shipments/{shipmentIdType}/{shipmentIdValue}
Get Shipment by Shipmentidtype and Shipmentidvalue
getShipmentByIdAndIdType 5 params → 200400401404500
POST
/shipments/{shipmentId}/acknowledge
Acknowledge Shipment
acknowledgeShipment 4 params body → 200400401404500
POST
/shipments/{shipmentId}/actions/update-gift-cards-status
Update Gift Card Activation Status
updateGiftCardStatus 4 params body → 200400401404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are shipmentResponse (26 properties), createShipmentRequest (22 properties), createShipmentByOrderRequest (19 properties), cartonItems (18 properties). Each schema is shown below with its type and property counts.

orderContactPhone
object
Contact person's phone details
2 properties
returnFeeDetail
object
Return fee details
5 properties
valueSearchFilter
object
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.
2 required
amountInCurrencyResource
object
Amount in currency details
3 properties 2 required
valuesSearchFilter
object
The search criteria when using multiple values. Condition between field and values is either IN or NIN when valuesSearchFilter is used.
2 required
shipmentResponse
object
Shipment details
26 properties 1 required
shipmentsResponse
object
Shipment response
1 property
orderContactName
object
Contact person's name
3 properties
orderAuditLogUpdatedField
object
Audit log for change history
2 properties
shipmentRecipient
object
Shipment recipient details
3 properties
shipmentSearchFilter
object
Criteria to find shipments. To search using a single value, the valueSearchFilter is considered. To search using multiple values, valuesSearchFilter is conside…
3 properties 2 required
shipmentScratchedItem
object
Customer may cancel allocation line items as part of the shipment post request. In fabric Shipments service, this is called 'Scratched Items' or 'scratchedItem…
8 properties 1 required
shipmentAcknowledge
object
Shipment acknowledgement details
2 properties
errorResponse
object
Error response
3 properties
shipmentItem
object
Details of item in shipment
16 properties
pagination
object
Pagination response
3 properties
shipmentTrackingDetail
object
Shipment tracking details
4 properties 2 required
shipmentGiftCardDetail
object
Gift card details
6 properties
createShipmentRequest
object
Details to create shipment
22 properties 2 required
trackingResource
object
Shipment tracking details
6 properties
giftCardItemsActivationRequest
object
Gift card activation request
1 property 1 required
createShipmentByOrderRequest
object
Request payload to create a shipment for an order.
19 properties 1 required
shipmentAuditLog
object
Details for updating shipment
10 properties
baseScratchedItemDetails
object
Base details of items scratched (removed) from a shipment.
11 properties 3 required
shipmentCarton
object
Carton details
12 properties
shipmentsSearchResponse
object
Shipment search response
2 properties
cartonDetails
object
Carton details
12 properties
cartonDetailsBasedOnOrder
object
Details of a carton included in a shipment, based on the order.
12 properties 1 required
giftCardItem
object
Gift card details
2 properties 2 required
shipmentAcknowledgeResponse
object
Shipment acknowledgement response
1 property
scratchedItemDetails
object
Details of scratched items in shipment
11 properties 3 required
cartonItems
object
Item details
18 properties 2 required
giftCardActivation
object
Gift card info
2 properties 2 required
address
object
Address details
14 properties 8 required
shipmentsSearchRequest
object
Sort and filter criteria for shipment search
2 properties 1 required
giftCardDetails
object
Gift card details
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fabric-com-shipments-api-openapi.yml Raw ↑

Other APIs fabric publishes across the network.

fabric Actions Endpoints API
fabric Addresses API
fabric Appeasements API
fabric Attributes API
fabric Authentication Endpoints API
fabric Bulk Import API
fabric Cancellations API
fabric Cart Actions API
fabric Cart Adjustments API
fabric Cart API
fabric Cart Fees API
fabric CartPayments API
Where this information came from

This is an independent, third-party profile of fabric Shipments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.