Introduction

Assure Magic is a set of APIs to facilitate communication between Assure and any custom e-commerce

platform. Using these APIs :

  • A client's e-commerce platform can get real time visibility of their inventory in the warehouse and take orders from customers accordingly.
  • Sync the customer orders generated on their e-commerce platform to Assure for warehouse fulfillment.
  • Let Assure know about the incoming customer returns to the warehouse and know about QC status customer returns.


There are various other use cases of these APIs and shall be incorporated in this document soon.

Note :

  • The term "Assure Magic" is abbreviated as "AM" and might be used frequently in this document.
  • The terms channel and marketplace are sometimes used interchangeably to refer to ecommerce platforms such as Amazon, Flipkart, Paytm, etc.



APIs


Authentication

For Authentication, authUsername and authPassword needs to be send in header of the rest API call.



Push calls from Channel


Order Push API


Pushing new orders to Assure. <BASE_URL> will be provided by Assure Magic team to the client working on integration with Assure Magic APIs.


URL


POST  <BASE_URL>/order


Content-Type application/json


Request Body

RawSample
{  
   "ack_by_time":"string",
   "billing_address":{  
      "city":"string",
      "country":"string",
      "email":"string",
      "first_name":"string",
      "last_name":"string",
      "line_four":"string",
      "line_one":"string",
      "line_three":"string",
      "line_two":"string",
      "mobile":"string",
      "state":"string",
      "zip":"string"
   },
   "dispatch_by_time":"string",
   "on_hold":true,
   "order_id":"string",
   "order_items":[  
      {  
         "cancelled_quantity":0,
         "discount_amount_item":0,
         "ean":"string",
         "gift_options":{  
            "gift":true,
            "gift_charge":0,
            "gift_message":"string",
            "giftwrap_required":true
         },
         "mrp":0,
         "order_item_id":"string",
         "ordered_quantity":0,
         "selling_price_per_item":0,
         "sku_id":"string"
      }
   ],
   "order_time":"string",
   "parent_order_id":"string",
   "payment_method":"COD",
   "shipping_address":{  
      "city":"string",
      "country":"string",
      "email":"string",
      "first_name":"string",
      "last_name":"string",
      "line_four":"string",
      "line_one":"string",
      "line_three":"string",
      "line_two":"string",
      "mobile":"string",
      "state":"string",
      "zip":"string"
   },
   "start_processing_time":"string",
   "warehouse_id":"string"
} 
{  
   "parent_order_id":132,
   "
warehouse_id":"Wid234",
   "order_id":"H19304030003",
   "order_time":"2018-10-01T08:18:25Z",
   "shipping_address":{  
      "email":"",
      "first_name":"Rohan",
      "last_name":"Kapadia",
      "mobile":"+911231231231",
      "line_one":"first line of the structured address",
      "line_two":"second line of the structured address",
      "line_three":"",
      "line_four":"",
      "city":"Bengaluru",
      "state":"Karnataka",
      "country":"India",
      "zip":"560103"
   },
   "billing_address":{  
      "email":"",
      "first_name":"Rohan",
      "last_name":"Kapadia",
      "mobile":"+911231231231",
      "line_one":"Addressline1",
      "line_two":"Addressline2",
      "line_three":"",
      "line_four":"",
      "city":"Bengaluru",
      "state":"Karnataka",
      "country":"India",
      "zip":"560103"
   },
   "order_items":[  
      {  
         "sku_id":2,
         "ean":2,
         "order_item_id":"102",
         "ordered_quantity":2,
         "cancelled_quantity":0,
         "mrp":"1500.0",
         "discount_amount_item":"0.0",
         "selling_price_per_item":"1500.0",
         "gift_options":{  
            "giftwrap_required":false,
            "gift":false,
            "gift_message":"",
            "gift_charge":0
         }
      },
      {  
         "sku_id":3,
         "ean":8,
         "order_item_id":101,
         "ordered_quantity":5,
         "cancelled_quantity":0,
         "mrp":"1500.0",
         "discount_amount_item":0.0,
         "selling_price_per_item":1500.0,
         "gift_options":{  
            "is_giftwraResponse Statusp_required":false,
            "is_gift":false,
            "gift_message":"",
            "gift_charge":0
         }
      }
   ],
   "on_hold":false,
   "dispatch_by_time":"2018-10-01T08:18:25Z",
   "ack_by_time":"2018-10-01T08:18:25Z",
   "payment_method":"NCOD"
}


Request Body Parameters

Parameter Name
Data Type
Description
Mandatory
ack_by_time
string`

Time by which order has to be

acknowledged.Time must be in ISO format. #


Optional
billling_addess

Billing address of the order
Yes
city
string
CityYes
country
stringCountry
Yes
email
stringEmail Id of customer
Yes
first_name
stringFirst name of customer
Yes
last_name
stringLast name of customer
Optional
line_one
stringAddress line one
Yes
line_two
string
Address line two
Optional
line_three
string
Address line three
Optional
line_four
string
Address line four
Optional
mobile
string
Mobile number
Yes
state
string
State
Yes
zip
string
Pin code

Yes
dispatch_by_time
string

Maximum time by which order must be

dispatched. Time must be in ISO format.


Optional
on_hold
boolean
True if order has been kept on hold
Optional
order_idstringOrder ID of orderYes
order_items

List of items in the order
Yes
cancelled_quantity
double
Cancelled quantity of the item
Optional
discount_amount_item
double
Discount amount per item
Yes
ean
string
European Article Number (EAN) of the item
Yes
gift_options

Gift options if order is to be sent as a gift
Optional
gift
boolean
Item is a gift or not
Optional
gift_charge
double
Extra charge to pack item as a gift
Optional
gift_message
string
Gift message
Optional
gift_wrap_required
boolean
Gift wrap required or not
Optional
mrp
double
Mrp of per item
Yes
order_item_id
string
Order item id of the item
Yes
ordered_quantity
int
Quantity of the item ordered
Yes
selling_price_per_item
double
Selling price of item after discount
Yes
sku_id
string
Stock keeping unit (or SKU) id of the item
Yes
order_time
string
Time at which order was placed. Time must be in ISO format.
Yes
parent_order_id
string
Order Id of the parent order #Yes
payment_method
string
Method of payment. Possible values : COD / NCOD
Yes
shipping address

Address to which order has to be delivered
Yes
start_processing_time
string
Used when onHold attribute is true. Time by which processing has to be started for the order.Time must be in ISO format.
Optional
warehouse_id
string
Warehouse from which the order has to be fulfilled
Yes


Response Body

Request Body is sent as response.



Response Status

Response Code
Response Type
200OK
400
BAD REQUEST




Return Order Push API


Pushing new return orders. <BASE_URL> will be provided by Assure Magic team to the client working on integration with Assure Magic APIs.


URL


POST <BASE_URL>/return-order


Content-Type  application/json


Request Body

Raw
Sample
{  
   "forward_order_number":"string",
   "order_items":[  
      {  
         "price":0,
         "reason_for_return":"string",
         "sku_id":"string",
         "status":"string",
         "sub_reason":"string"
      }
   ],
   "order_type":"string",
   "return_order_id":"string",
   "tracking_id":"string",
   "transporter":"string",
   "warehouse_id":"string"
}
{  
   "forward_order_number":"108",
   "warehouseId":"Wid234",
   "order_items":[  
      {  
         "price":"1500.0",
         "reason_for_return":"Different Size",
         "sku_id":3,
         "status":"initiated",
         "sub_reason":"size"
      }
   ],
   "order_type":"SELF_SHIP",
   "return_order_id":101,
   "tracking_id":"HYN402",
   "transporter":"BlueDart"
}


Request Body Parameters

Parameter Name
Data TypeDescription
Mandatory
forward_order_number
string
# Original Order Number against which return created
Yes
order_items

List of items to be returned
Yes
price
double
Price per item
Yes
reason_for_return
string
Reason for return
Optional
sku_id
string
Stock keeping unit (or SKU) id of the item
Yes
sub_reason
string
Sub Reason for Return
Optional
order_type
string
Type of return. Possible Values: RETURN_TO_ORIGIN/CUSTOMER_RETURN/SELF_SHIP
Yes
return_order_id
string
Return Order Id
Yes
tracking_id
string
Tracking number assigned to return order
Yes
transporter
string
Transport Service
Yes
warehouse_id
string
Warehouse to which item comes on return.
Yes


Response Body

Request Body is sent as response.



Response Status

Response CodeResponse Type
200OK
400BAD REQUEST




Order Cancellation Push API


Pushing order cancellations. <BASE_URL> will be provided by Assure Magic team to the client working on

integration with Assure Magic APIs.


URL


PUT <BASE_URL>/cancel-order


Content-Type: application/json


Request Body

Raw
Sample
{  
   "cancel_items":[  
      
{  
         "cancelled_quantity":0,
         "order_item_id":"string",
         "reason":"string",
         "sku_id":"string"
      }
   ],
   "order_id":"string"
}
{  
   "cancel_items":[  
      {  
         "order_item_id":"102",
         "cancelled_quantity":1,
         "sku_id":"2"
      },
      {  
         "order_item_id":"101",
         "cancelled_quantity":4,
         "sku_id":"3"
      }
   ],
   "order_id":"H19304030001"
}


Request Body Parameters

Parameter Name
Data Type
Description
Mandatory
cancel_items

List of items to be cancelled
Yes
cancelled_quantity
int
Quantity of item that has to be cancelled
Yes
order_item_id
string
Item Id of the item
Yes
reason
string
Reason for cancellation
Optional
sku_id
string
Stock keeping unit (or SKU) id of the item
Yes
order_id
string
Order Id of the order to which this item belongs
Yes



Response Body

Request Body is sent as response.


Response Status

Response Code
Response Type
200
OK
400
BAD REQUEST



Channel calls from Assure


Update Inventory


Update the channel with available inventory. Maximum 100 inventory updates will be sent in one request.


URL


POST <CLIENT_PLATFORM_POST_INVENTORY_UPDATE_URL>


Content-Type: application/json



Request Body

Raw
Sample

{  

   "warehouseId":"string",

   "inventories":[  

      {  

         "quantity":0,

         "skuId":"string"

      }

   ]

}


{  

   "warehouseId":"wd003",

   "inventories":[  

      {  

         "quantity":40,

         "skuId":"302"

      }

   ]

}



Request Body Parameters

Parameter Name
Data Type
Description
Mandatory
warehouseId
string
Warehouse where inventory has to be updated
Yes
inventories

List of inventories
Yes
quantity
intAvailable quantity of each SKU
Yes
skuId
string
Stock keeping unit (or SKU) id of the item
Yes


Response


1) In case of success 200 OK along with Response Body.


Response Body

Raw
Sample

{  

   "failureSkuList":[  

      "string"

   ],

   "successSkuList":[  

      "string"

   ]

}


{  

   "failureSkuList":[  

      "302"

   ],

   "successSkuList":[  


   ]

}



Response Body Parameters

Parameter Name
Data Type
Description
failureSkuList
String
List of SkuIds whose inventory update failed
successSkuList
String
List of SkuIds whose inventory update succeeded


2) In case of failure (Code 400 OR 500)


Error Data

{ "code": int,

"description":"string"

}


Create Shipment


Create shipment of a list of order items call to create shipment must return same response for a particular shipment unless the shipment is handovered.


URL


POST <CLIENT_PLATFORM_CREATE_SHIPMENTS_FOR_ORDER_ITEMS_URL>


Content-Type: application/json


Request Body


Raw
Sample

{

"warehouseId": "string",

"invoiceId": "string",

"orderId": "string",

"shipmentId": 0,

"shipmentItems": [

{

"serialNo": "string",

"skuId": "string",

"orderItemId": "string",

"quantity": 0

}

]

}


{

"orderId" : "H19304030001",

"shipmentId" : "456123",

"invoiceId" : "in9078",

"shipmentItems" : [

{

"orderItemId" : "300012",

"skuId" : "101",

"serialNo" : "02",

"quantity" : "7"

}

]

}



Request Body Parameters


Parameter Name
Data Type
Description
Mandatory
warehouseId
string
Warehouse Id of warehouse from where order is fulfilled
Yes
invoiceIdstring
Invoice id of invoice generated for the shipment
No
orderId
string
Order Id of order
Yes
shipmentId
long
Shipment Id generated by AM
No
shipmentItems

List of Items in shipment
Yes
serialNo
string
Serial number of an item #
No
skuId
string
Stock keeping unit (or SKU) id of the item
Yes
orderItemId
string
Item id
Yes
quantity
intQuantity of item to be shipped in this shipment
Yes



Response


1) In case of success

200 OK along with Response Body.

Response Body


Raw
Sample

{

"shipmentId": "string"

}


{

"shipmentId" : "eid2345"

}


Response Body Parameters


Parameter Name
Data Type
Description
shipmentId
string
Shipment Id provided by channel


2) In case of failure (Code 400 OR 500)

Error Data


{

"code": int,

"description":"string"

}




Get Shipment


Get shipment details. If shipment has been created then this should always return response atleast until the shipment is handovered.


URL


GET <CLIENT_PLATFORM_GET_SHIPMENT_BY_ORDER_ID_URL>


Content-Type: application/json



Query Parameters


Field
Sample Values
Data Type
Description
orderId
H19304030001
String
Order id of order
shipmentId
eid2345
String
Shipment Id provided by channel


Sample Url : <CLIENT_PLATFORM_GET_SHIPMENT_BY_ORDER_ID_URL>?orderId=H19304030001&shipmentId=eid2345


Response


1) In case of success

200 OK along with Response Body.



Response Body

Raw
Sample
{
   "awbNumber":"string",
   "invoiceUrl":"string",
   "shippingLabelUrl":"string",
   "transporter":"string"
}
{
   "invoiceUrl":"SomeUrlToDownloadPDFfrom",
   "shippingLabelUrl":"SomeUrlToDownloadPDFfrom",
   "awbNumber":"MIX234",
   "transporter":"EPorter"
}


Response Body Parameters

Parameter Name
Data Type
Description
awbNumber
String
Air waybill(AWB) number of the shipment
invoiceUrl
StringUrl from which invoice has to be downloaded
shippingLabelUrl
String
Url from which shipment label has to be downloaded
transporter
StringName of Transport Service



2) In case of failure (Code 400 OR 500)


Error Data

   "code":int,

   "description":"string"

}



Get Shipment List


Get List of shipments created on channel for a given Order Id. This call will only be used when partial packing is

allowed. This should always return response for any particular order atleast until the order is handover.

URL


GET <CLIENT_PLATFORM_GET_SHIPMENTS_BY_ORDER_ID_URL>


Content-Type: application/json


Query Parameters


Field
Sample Values
Data Type
Description
orderId
H19304030001
String
Order id of order


Sample Url : <CLIENT_PLATFORM_GET_SHIPMENTS_BY_ORDER_ID_URL>?orderId=H19304030001


Response


1) In case of success

200 OK along with Response Body.


Response Body

Raw
Sample

   "orderId":"string",

   "shipmentItems":[ 

      { 

         "shipmentId":"string",

         "items":[ 

            { 

               "orderItemId":"string",

               "skuId":"string",

               "quantity":0

            }

         ]

      }

   ]

}


   "orderId":"H19304030001",

   "shipmentItems":[ 

      { 

         "shipmentId":"esid0002",

         "items":[ 

            { 

               "orderItemId":"300012",

               "skuId":"101",

               "quantity":"4"

            }

         ]

      }

   ]

}





Response Body Parameters

Parameter Name
Data Type
Description
orderId
string
Order id of order
shipmentItems

List of shipments already created for an order
shipmentId
string
Shipment Id provided by channel
items

List of items in a shipment
orderItemIdstring
Item Id
skuId
string
Stock keeping unit (or SKU) id of the item
quantity
int
Quantity of item in shipment


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}


Create Manifest


Create manifest of a list of shipments.

Call to create manifest must return same response for a particular shipment atleast until the shipment is

handovered.

URL


POST <CLIENT_PLATFORM_CREATE_MANIFEST_FOR_SHIPMENTS_URL>


Content-Type: application/json


Request Body

Raw
Sample

   "warehouseId":"string",

   "manifestItems":[ 

      { 

         "shipmentId":"string",

         "awbNumber":"string",

         "orderId":"string"

      }

   ],

   "provider":"string"

}


{
   "provider":"WERTYU",
   "warehouseId":"wd02",
   "manifestItems":[
      {
         "orderId":"H19304030001",
         "shipmentId":"eid123",
         "awbNumber":"awb123"
      }
   ]
}


Request Body Parameters

Parameter Name
Data Type
Description
warehouseId
string
Warehouse Id where shipments were created
manifestItems

List of shipments in a manifest
shipmentId
string
Channel shipment id of shipment
orderId
string
Order Id of order whose shipments are to be manifested
provider
string
transporter
awbNumber
string
Airway Bill Number


Response


1) In case of success

200 OK along with Response Body.


Response Body

Raw
Sample
[
   {
      "manifestId":"string",
      "shipments":[
         {
            "orderId":"string",
            "shipmentId":"string"
         }
      ]
   }
]
[
   {
      "manifestId":"72653",
      "shipments":[
         {
            "orderId":"515",
            "shipmentId":"95848"
         }
      ]
   }
]


Response Body Parameters

Parameter Name
Data Type
Description
manifestId
string
manifest id provided by channel. If some shipments are already manifested, then size of list will be more than 1.Then the list will contain already created manifests as well as new manifest.
shipments
list
shipments under manifest
orderId
string
orderId to which the shipment belongs
shipmentId
string
shipmentId of the shipment under the manifest
awbNumber
string
awbNumber of the shipment


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}




Get Manifest


Get manifest details from channels.

If manifest has been created then this should always return response atleast until the order is handover.


URL


GET <CLIENT_PLATFORM_GET_MANIFEST_URL>


Content-Type: application/json


Query Parameters


Field
Sample Values
Data type
Description
manifestId
eid123
string
Channel manifest Id of manifest


Sample Url : <CLIENT_PLATFORM_GET_MANIFEST_URL>?manifestId=eid123


Response

1) In case of success

200 OK along with Response Body.


Response Body

Raw
Sample
{
   "manifestId":"string",
   "manifestUrl":"string"
}
{
   "manifestId":"eid123",
   "manifestUrl":"wd02"
}


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}



Handover Orders


Informing channel about orders to be handed over to courier.

Shipment id used here is id returned during create shipment call from channel .


If handover request is made for an already handovered shipment, then in response the shipment must be in

success list and not in failure list.


URL


POST <CLIENT_PLATFORM_POST_HANDOVER_STATUS_URL>


Content-Type: application/json


Request Body


Raw
Sample
{
   "shipments":[
      {
         "shipmentId":"string",
         "manifestId":"string",
         "awbNumber":"string"
      }
   ]
}
{
   "shipments":[
      {
         "shipmentId":"ship123",
         "manifestId":"mani123",
         "awbNumber":"123abc"
      }
   ]
}


Request Body Parameters

Parameter Name
Data Type
Description
shipment

List of shipments to be handed over
shipmentId
String
List of channel shipment ids which needs to be handovered
manifestId
String
ManifestId of the shipment
awbNumber
String
Airway Bill Number


Response


1) In case of success

200 OK along with Response Body.


Response Body


Raw
Sample
{
   "failureShipments":[
      {
         "shipmentId":"string",
         "orderId":"string"
      }
   ],
   "successShipments":[
      {
         "shipmentId":"string",
         "orderId":"string"
      }
   ]
}
{
   "successShipments":[
      {
         "orderId":"H19304030001",
         "shipmentId":"eid123"
      }
   ],
   "failureShipments":[
      {
         "orderId":"H19304030005",
         "shipmentId":"fid123"
      }
   ]
}


Response Body Parameters

Parameter Name
Data Type
Description
failureShipments

List of shipments which can't be handovered
shipmentId
string
Shipment id of shipments
orderId
string
Order id of order
successShipments

List of shipments which can be handovered successfully


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}



Acknowledge Return Orders


Send Acknowledgement to channel for Return Orders.


URL


PUT <CLIENT_PLATFORM_RETURN_ORDER_ACKNOWLEDGEMENT_URL>


Content-Type: application/json


Request Body

RawSample
{
   "warehouseId":"string",
   "items":[
      {
         "qcReason":"DAMAGED",
         "qcStatus":"PASS",
         "skuId":"string"
      }
   ],
   "returnOrderId":"string"
}
{
   "returnOrderId":"H893RUOT123",
   "items":[
      {
         "skuId":"102",
         "qcStatus":"FAIL",
         "qcReason":"DAMAGED"
      }
   ],
   "warehouseId":"wd101"
}


Request Body Parameters

Parameter Name
Data Type
Description
warehouseId
string
Warehouse Id where return order will be received
items

List of items in return order
qcReason
string

Quality Check failed reasons. Possible Values :

DAMAGED,STAINED,

BROKEN_STITCH,

FABRIC_DEFECT,

SHADE_VARIATION,

LOGO_MISSING,

UNEVEN_LENGTH,

WRONG_PAIR,

USED_PRODUCT,

TAG_BOX_MISMATCH,

TAG_MISSING,

WARRANTY_CARD_MISSING,

PART_MISSING,

BOX_DAMAGE,

PRODUCT_MISMATCH,

STICKER_MISMATCH,

PRODUCT_MISSING

qcStatus
string

Quality Check. Possible Values :

PASS

FAIL

skuId
string
Stock keeping unit (or SKU) id of the item
returnOrderId
string
Return Order id


Response


1) In case of success

200 OK.


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}



Order Cancellation from Seller


Send line item cancellation quantity to channel. This is allowed before packing only .


In case of complete order cancellation, all line items will be there in the request body with cancelled quantity

populated. In case of partial cancellation, only those line items will be present whose cancellation has been

triggered by seller.


URL


PUT <CLIENT_PLATFORM_SELLER_ORDER_CANCELLATION_URL>


Content-Type: application/json


Request Body

RawSample


{
   "orderId":"string",
   "lineItems":[
      {
         "orderItemId":"string",
         "skuId":"string",
         "orderedQuantity":int,
         "cancelledQuantity":int
      }
   ]
}
{
   "orderId":"H893RUOT123",
   "lineItems":[
      {
         "orderItemId":"102",
         "skuId":"1001",
         "orderedQuantity":5,
         "cancelledQuantity":1
      }
   ]
}


Request Body Parameters

Parameter Name
Data Type
Description
orderId
string
Order Id
lineItems

List of cancelled lineItems in order
orderItemId
string
order Item Id of line item
skuId
stringStock keeping unit (or SKU) id of the item
orderedQuantityintquantity that was initially ordered
cancelledQuantity
int
quantity that is cancelled


Response


1) In case of success

200 OK


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}



Get Order By OrderId


Get order status by channel orderId.

This should always return response for an existing order. If the order has been fulfilled then also response with proper order status is expected.


URL


GET <CLIENT_PLATFORM_GET_ORDER_BY_ORDER_ID>


Content-Type: application/json


Query Parameters


Field
Sample Values
Data Type
Description
orderId
H19304030001
String
Order id of order
warehouseId
Wid2345
String
WarehouseId


Sample Url : <CLIENT_PLATFORM_GET_ORDER_BY_ORDER_ID>?orderId=H19304030001&warehouseId=Wid2345


Response


1) In case of success

200 OK along with Response Body.


Response Body

Raw
Sample

{

"awbNo": "string",

"transporter": "string",

"expectedDeliveryTime": "string",

"manifestId": "string",

"onHold": true,

"orderId": "string",

"orderItems": [

{

"cancelledQuantity": 0,

"discountAmountItem": 0,

"lineItemId": "string",

"mrp": 0,

"orderedQuantity": 0,

"sellingPricePerItem": 0,

"skuId": "string"

}

],

"processingStartTime": "string",

"shipmentId": "string",

"status": "CREATED",

"warehouseId": "string"

}


{

"awbNo": "test_204",

"transporter": "Delhivery",

"expectedDeliveryTime": "2018-10-01T08:18:25Z",

"manifestId": "Mid1234",

"onHold": false,

"orderId": "Ch!234",

"orderItems": [

{

"cancelledQuantity":3,

"discountAmountItem": 200,

"lineItemId": "I23",

"mrp": 400,

"orderedQuantity": 4,

"sellingPricePerItem": 400,

"skuId": "45672839Id"

}

],

"processingStartTime": "2018-10-01T08:18:25Z",

"shipmentId": "Ship1234",

"status": "MANIFESTED",

"warehouseId": "101"

}



Response Body Parameters

Parameter Name
Data Type
Description
awbNo
String

Air waybill(AWB) number of the shipment (Null/Empty if shipment not created)

transporter
String
Transport Service (Null/Empty if shipment not created)
dispatchByTime
String

Maximum time by which order must be dispatched. Time must be in ISO

format.

manifestId
String
Manifest Id of shipment(Null/Empty if manifest not created)
onhold
Boolean
True if order has been kept on hold
orderId
String
Order Id of order
orderItems
List
List of items in the order
cancelledQuantity
Integer
Cancelled quantity of the item
discountAmountItem
Double
Discount amount in the item
orderItemId
String
Order item id of the item
mrp
Double
Mrp of the item
orderedQuantity
Integer
Quantity of the item ordered
sellingPricePerItem
Double
Selling price of item after discount
skuId
String
Stock keeping unit (or SKU) id of the item
processingStartTime

String

Used when onHold attribute is true. Time by which processing has to

be started for the order. Time must be in ISO format

shipmentId
String

Shipment Id of the shipment created for this order(Null/Empty if

shipment not created)

warehouseIdString
Warehouse from which the order has to be fulfilled
status
StringStatus of order. Possible values : NEW,PACKED,MANIFESTED,HANDOVERED,DELIVERED,CANCELLED


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}



Get Inventory Count


Get quantity of a particular sku


URL


GET <CLIENT_PLATFORM_GET_INVENTORY_COUNT_BY_SKU_ID>


Content-Type: application/json


Query Parameters


Field
Sample Values
Data Type
Description
skuId
H1901String
Sku Id


Sample Url : <CLIENT_PLATFORM_GET_INVENTORY_COUNT_BY_SKU_ID>?skuId=H1901


Response


1) In case of success

200 OK along with Response Body.


Response Body

Raw
Sample
{
   "inventories":[
      {
         "skuId":"string",
         "warehouseId":"string",
         "quantity":0,
         "skuEnabled":false
      }
   ]
}
{
   "inventories":[
      {
         "skuId":"H1901",
         "warehouseId":"101",
         "quantity":12,
         "skuEnabled":true
      }
   ]
}


Response Body Parameters

Parameter Name
Data Type
Description
inventoriesList
Quantity of sku in different warehouses
quantity
Integer
quantity of the item(0 if not present)
skuIdString
Stock keeping unit (or SKU) id of the item
warehouseId
String
Warehouse from which the order has to be fulfilled
skuEnabledBooleanWhether sku is enable or disable


2) In case of failure (Code 400 OR 500)


Error Data

{

"code": int,

"description":"string"

}


Rate Limit for api calls


API calls to Assure Magic are limited to 10 requests per sec by default. This figure is not per API but cumulitive. The request limit is configurable at our end .