Fabric API Reference
Fabric API Reference
Introduction
Browse all topics
Users
About Users APIs
Create Local User
Login Local User
Refresh User Token
Get User Details
Update User Details
Update Username
Reset Password
Verify Reset Token
Update Password
Change Password
Create Address
Update Address
Delete Address
Get Address by ID
Get Address by Kind
Get All Addresses of User
Set Default Address
Unset Default Address
Cart
About Cart APIs
Add Items to Cart
Retrieve Cart by Cart ID or userAuthToken
Remove Item from Cart
Empty Cart
Update Cart
Apply Promo
Remove Promo
Merge Guest and User Carts
Delete Cart
Add ship-to to Line Items
Ship-to
Create Shipping
Retrieve Shipping by shipTo ID
Retrieve Cart by Ship-to ID
Update Shipping
Bill-to
Create Billing
Retrieve Bill-to by ship-to ID
Retrieve Billing by Bill-to ID
Update Billing
Decoupled Cart
About Decoupled Cart
Add Items to Cart
Retrieve Cart by Cart ID or userAuthToken
Remove Item from Cart
Update Cart
Merge Guest and User Carts
Empty Cart
Delete Cart
Orders
About Orders APIs
Add Shipment
Cancel Order
Bulk Order Cancel
Cancel Orders By Order ID
Order Search
Order Checkout (Credit Card)
Order Checkout (Affirm)
Retrieve Orders By User
Retrieve Orders By Email
Retrieve Order By ID
Shipping
About Shipping APIs
Shipping - Get By ID
Shipping - Get All
Shipping - Get Available
Tax
Create Estimate Transaction
Wishlist
About Wishlist APIs
Add Item to Wishlist
Get Wishlist by userAuthToken
Delete Item from Wishlist
Inventory
About Inventory APIs
Get Multiple by itemId
Inventory - Bulk Insert
Items
About Items APIs
Get Items by itemIds
Get Item by itemId
Get item and price by SKU
Get items by SKUs
Notifications
About Notifications API
Communication - Send Email
XM
About XM
Retrieve Live Pages
Retrieve Page by URL
Retrieve Live Global Components
Retrieve Menu List
Retrieve Menu Items by Menu ID
Retrieve Menu Items
Promotions
About Promotions
Validate Promotions
Retrieve a List of Promotions
Retrieve a Single Promotion
Price
About Price
Retrieve Price by Item IDs
Retrieve Price by Item and Price List IDs
Set Price
Set Bulk Price
Subscriptions
About Subscriptions
Create Subscriptions
Update Subscriptions
Retrieve All Subscriptions
Retrieve Single Subscription
Retrieve Order by Order ID
Retrieve All Orders by Customer Reference ID
Retrieve All Scheduled Orders
Retrieve Orders by Subscription ID
Remove single subscription
Skip Subscription
Subscription Customers
About Customers
Retrieve All Subscribers
Retrieve Single Subscriber
Subscription Plans
About Plans
Create Plan
Update Plan
Count Plans
Retrieve Plan by Item ID and Price List ID
Retrieve Plans by Item IDs
Retrieve All Plans
Retrieve Single Plan
Remove Plan
Powered by GitBook

Add Shipment

Path:

POST /api-order/orders/shipments

This endpoint offer your customers the flexibilty to select shipment of their choice.

Headers

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

x-api-key : d41d8cd98f00b204e9800998ecf8427e

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: body

Name: shipment details

Required: true

Sample Request

{
	"orderId": "4217-7227-80339",
	"shipments": [
        {
          "shipmentRef": "ref-100",
          "shipmentCarrier": "Fedex",
          "shipmentCarrierUrl": "https://fedex.com",
          "trackingNumber": "2345367890876549",
          "lineItems": [
            {
              "lineItemId": 2,
              "quantity": 1
            }
          ],
          "shipmentStatus": "awaiting",
          "estimatedDeliveryDate": "2019-03-01",
          "shippedDate": "2020-04-05"
        }
      ]
}
​

Response

Response Code: 200

Message: OK

Sample

{
    "orderId": "4217-7227-80339",
    "status": "Successfully added shipment"
}

​

Changelog

  • Last Updated - April 2021

  • First Updated - July 2020

Orders - Previous
About Orders APIs
Next - Orders
Cancel Order
Last updated 3 weeks ago