What is the purpose of this article ?

This is a sub document of the the main doc Shipping App
Create order new Api (updated with discussed points)

The purpose of this article is to convert the request body from unicommerce to the desired create order request.

Flow Diagram

Open

What are the steps to achieve this task ?

1. An API will be exposed which unicommerce where unicommerce will send POST request for label generation. The post request body has been menytioned in step 3.

   1. Api details

      Endpoint: /waybill Request Type: POST Scheme: HTTPS Header (content-type) application/json Header (Authorization): token (got from SP Authentication)

2. Check if source = unicommerce

3. Map the unicommerce keys with our desired create order request.

   { "serviceType": "String",------------------------> shippngMode (Eshopbox Standard/ Eshopbox express) "Shipment": { "code": "String",-----------------------------> M-----shipmentID "SaleOrderCode": "String",--------------------> M "orderCode": "String",------------------------> M-----customerOrderId "channelCode": "String",------------------------------channelId "channelName": "String", "source": "unicommerce",------------------------------orders.origin "customField" : [], "invoiceCode": "String",------------------------------invoice.number "orderDate": "16-Sep-2021 00:00:00",----------> M-----orderDate "fullFilllmentTat": "18-Sep-2021 00:00:00", "weight": "53.4000",--------------------------> M------shipmentDimensions.weight "length": "30",-------------------------------> M------shipmentDimensions.length "height": "10",-------------------------------> M------shipmentDimensions.height "breadth": "15",------------------------------> M------shipmentDimensions.breadth "numberOfBoxes": "1",-------------------------> M - "items": [ - { - "name": "String",-------------------------> M------items.productTitle "description": "String",------------------> M - "quantity": 2,----------------------------> M------items.quantity "skuCode": "string",----------------------> M------items.itemID "itemPrice": 600.00,----------------------> M------items.itemTotal "imageURL": "string",------------------------------items.productImageUrl) (to be added in our request) "hsnCode": "string",-------------------------------items.hsn "tags": "string", "brand": "string", "color": "string", "category": "string", "size": "string", "item_details": "string", "ean": ""------------------------------------------items.ean }, { "name": "String", "description": "String", "quantity": 1, "skuCode": "string", "itemPrice": 600.00, "imageURL": "string", "hsnCode": "string", "tags": "string", "brand": "string", "color": "string", "category": "string", "size": "string", "item_details": "string", "ean": "" } ] }, "deliveryAddressId": "String", "deliveryAddressDetails": { "name": "String",------------------> M-----shippingAddress.customerName "email": "String",-----------------> M-----shippingAddress.email "phone": "8888888888",-------------> M-----shippingAddress.contactPhone "address1": "String",--------------> M-----shippingAddress.addressLine1 "address2": "String",----------------------shippingAddress.addressLine2 "pincode": "122016",---------------> M-----shippingAdress.pincode "city": "Gurgaon",-----------------> M-----shippingAdress.city "state": "Haryana",----------------> M-----shippingAdress.state "country": "India",----------------> M-----shippingAdress.country "stateCode": "HR",-----------------> M "countryCode": "IN",---------------> M "gstin": "string",-------------------------shippingAdress.gstin "alternatePhone": "9090909090", "district": "" }, "pickupAddressId": "String",---------------> pickupLocation.locationCode "pickupAddressDetails": { "name": "String",------------------> M-----pickupLocation.locationName "email": "String",-----------------> M "phone": "9999999999",-------------> M-----pickupLocation.contactNumber "address1": "String",--------------> M-----pickupLocation.addressLine1 "address2": "String",----------------------pickupLocation.addressLine1 "pincode": "400092",---------------> M-----pickupLocation.pincode "city": "Mumbai",------------------> M-----pickupLocation.city "state": "Maharashtra",------------> M-----pickupLocation.state "country": "India",----------------> M "stateCode": "MH",-----------------> M "countryCode": "IN",---------------> M "gstin": "string"--------------------------pickupLocation.gstin }, "returnAddressId": "String", "returnAddressDetails": { "name": "String",------------------> M "email": "String", "phone": "9999999999",-------------> M "address1": "String",--------------> M "address2": "String", "pincode": "400092",---------------> M "city": "Mumbai",------------------> M "state": "Maharashtra",------------> M "country": "India",----------------> M "stateCode": "HR",-----------------> M "countryCode": "IN",---------------> M "gstin": "string"------------------> M }, "currencyCode": "INR",---------------> M "paymentMode": "PREPAID",------------> M----isCOD "totalAmount": "200.00",-------------> M----invoiceTotal "collectableAmount": "0",------------> M----balanceDue "courierName": "String", "customField": [ { "name": "String", "value": "String" }, { "name": "String", "value": "String" } ] }

4. Esb shipping order core flow will work which will generate label and make entries in DB.

5. Return the label details in response of the API. Response remains same as the response of our core flow

   success Response :- { "courierName": "Self", "waybill": "874320208625", "label_url": "https://storage.googleapis.com/eshopbox_wms_uploads_staging/myntraLabel/202405061317301511071119.pdf", "shipmentId": "wdcTest_54-5865-9684", "routingCode": "ASB-ZBX", "labelStream": "", "shippingMode": "Express" } Failure Response we are returning :- { "errors": [ { "code": "400", "message": "Label couldn't be generated due to pincode not serviceable" } ] } This is the expected failure response for Unicommerce. Need to discuss { "status":"FAILED", "reason":"String", "message":"String" }