Post Orders

This REST API is used by marketplaces to post new orders in Uniware. Generally, the orders are fetched by Uniware using the Get Orders API, however this is an additional functionality where the marketplaces can post the orders to the Uniware.

Tip

• This is an optional feature used only when the marketplaces wish to post orders in Uniware.
• This API request is initiated by the marketplace to post information (orders) in Uniware. For such APIs a unique static securitykey is provided by the Unicommerce to the marketplaces for authentication. This securitykey should be passed in header as mentioned below.
• It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NOTE:

The charges and price details can be provided either at order level or order item level (charges which are common), but not in both. However, it is recommended to send price at order item level for better handling.

Request Payload

{
   "id": "string",
   "displayOrderNumber": "string",
   "orderDate": "2022-12-05 08:12:53",
   "orderStatus": "CREATED",
   "sla": "2022-12-06 08:12:53",
   "priority": 0,
   "paymentType": "string",
   "orderPrice": {
      "currency": "string",
      "totalCashOnDeliveryCharges": 0,
      "totalDiscount": 0,
      "totalGiftCharges": 0,
      "totalStoreCredit": 0,
      "totalPrepaidAmount": 0,
      "totalShippingCharges": 0
   },
   "orderItems": [
      {
         "orderItemId": "string",
         "status": "CREATED",
         "productId": "string",
         "variantId": "string",
         "sku": "string",
         "title": "string",
         "shippingMethodCode": "STD",
         "orderItemPrice": {
            "cashOnDeliveryCharges": 0,
            "sellingPrice": 0,
            "shippingCharges": 0,
            "discount": 0,
            "totalPrice": 0,
            "transferPrice": 0,
            "currency": "string"
         },
         "quantity": 0,
         "giftWrap": {
            "giftWrapMessage": "string",
            "giftWrapCharges": 0
         },
         "onHold": false,
         "packetNumber": 0,
         "facilityCode" : "string"
      }
   ],
   "taxExempted": false,
   "cFormProvided": false,
   "thirdPartyShipping": false,
   "shippingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "country": "string",
      "email": "string",
      "name": "string",
      "phone": "string",
      "pincode": "string",
      "state": "string"
   },
   "billingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "country": "string",
      "email": "string",
      "name": "string",
      "phone": "string",
      "pincode": "string",
      "state": "string"
   },
   "additionalInfo": "string"
}

Request Payload Details

Response Payload

{
   "status": "success",
   "message": "Order created successfully",
   "data": null
}

Response Payload Details

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. If facilityCode is not passed by any Marketplace, what will happen in that case?
Ans. The facility will be allocated according to the Uniware facility allocation rules.

Q2. What will happen in the cases where such a “facilityCode” is passed by channel which is not available in the Location ID Mapping in the connectors?
Ans. In such cases, orders will not be created into the system, provided there is a mapping set by the seller already.

Q3. Will it affect any old integration?
Ans. This will not affect any of our existing integrations in any way, as previously their orders were processed using facility allocation rules and now also it’ll still work the same way. But in future if the marketplace wants to use this “facilityCode” based handling, we’ll have to update the merchant in our database.

Q4. Can billing addresses be fetched and updated via API as we are working on a bill to ship to a business model where the customer invoice raised has to be billed by the MP?
Ans. The billing address can be fetched using both Post Orders API and Get Orders API. But using MP integration we can’t update the same instead the updated address can only be re-fetched if needed.

Q5. There are two types of status fields in the response for this API, for order item and order item id, what is the difference between them?
Ans. There are two types of status mappings in UC, one for order as a whole and one for the order item id for the separate products in the order. For more details refer to the Status Definition header on Get Orders document.

Q6. By post order API, Can we (MP) pass discount values and shipping charges at item level?
Ans. As of now, you can not pass these values at item level as the system is not designed to handle this condition. Instead of this you can take “Get orders” api. or use the order level field with all cumulative values.

Q7. There are two types of charges as order level and order item level, what is the difference between them??
Ans. The charges and price details can be provided either at order level or order item level (charges which are common), but not in both. However, it is recommended to send price at order item level for better handling. Also, order item level charges (except sellingPrice and totalPrice) are cumulative or sum for all unique items.

Q8. What data will be passed in OrderID & OrderItemID in the response?
Ans. OrderID & OrderItemID These Id must be unique as UC will use these ids in consecutive apis. The API design should be kept in consideration with the possibility of these filters as it might be helpful during debugging of any issues as such.