Create order (+pull flow)

This doc is “work in progress”

Step 1. Listen to PubSub for the CreateOrder event and get QueueData from it.

QueueData:

{
    "queueData": {
        "channelData": {
            "externalChannelId": "CH5811",
            "accountSlug": "montecarlo",
            "connectionId": 78,
            "location": {
                "F21BD": "Warehouse",
                "58291912872": "Warehouse"
            },
            "wmsAccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJVVXdSREZCUVRSRFFqQkdORFUxTVVZeE16ZEdPRFJHTnpORk5EaEJSVEU0TVVORk5qVTJOdyJ9.eyJodHRwczovL2FwcERhdGEiOnsiYXBwQ2xpZW50SWQiOiI3YmM0ZTExYTdlMzFmYWRjMTk5ZDI5Y2ViZTIyYzY3MiJ9LCJodHRwczovL2FjY291bnRTbHVnIjoibW9udGVjYXJsbyIsImh0dHBzOi8vdXNlckRldGFpbHMiOnsiaWQiOjExMzEsInVzZXJUeXBlIjoiZGVmYXVsdCIsImVtYWlsIjoiYXBwdXNlcjExNEBlc2hvcGJveC5jb20ifSwiaHR0cHM6Ly9hY2NvdW50cyI6WyJtb250ZWNhcmxvIl0sImh0dHBzOi8vd2FyZWhvdXNlV29ya3NwYWNlcyI6W10sImh0dHBzOi8vd2FyZWhvdXNlcyI6W10sImh0dHBzOi8vcGFydG5lcnMiOltdLCJpc3MiOiJodHRwczovL2VzaG9wYm94LXBheW1lbnQtcmVjby5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NjA3NTQxMmE2NjUwOGYwMDY4YmIzZTQwIiwiYXVkIjoiaHR0cHM6Ly9lc2hvcGJveC1wb3J0YWwtZGV2LmFwcHNwb3QuY29tIiwiaWF0IjoxNjU3MDEzNjM3LCJleHAiOjE2NTk2MDU2MzcsImF6cCI6Inc4dllYa2ZMSWZmOFl2Mmo0TzNUOUplYWoxUzNxOHJlIiwic2NvcGUiOiJyZWFkOnByb2R1Y3RzIHJlYWQ6aW52ZW50b3J5IHJlYWQ6cHJvZHVjdF9saXN0aW5ncyIsImd0eSI6InBhc3N3b3JkIn0.n3b_xeFb4Hutay0h-6Pu-m_6netxymzt_AAw9G7OAjYUY8obqsVLFDG_qIPj2z2OS0-W5f1hUNxy82tfHrsG-_Nxy39rUoXNXLTWg7QQtDbF6OVJmYW55QmdIf5QU8Z7vpE2z9FeQ4QL6x6jDsTzLuBteJdu49AL34W0OcKcOOOhrjnui1phoB1Glc3AbNMwXSBQncq9MLeeu6J_8-THyXZLSAaxHZiH3AwJoJXcrN4EQLQhCN9rVAX1wuxATCNIHrlapfIngr7-tFZ0ffYccEaFdWNlrKeOyQVZccieneC4w7FCXlPr16VVsCJBsKYLVoDnXKmEH1mcAhA6ARI-UQ",
            "tataCliqAccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik1UaERRamxDUlRJelJVUTRRVU0wUVRJNU1FSkVOVGszUVVFeU5qVXdSa1JDTmpBeU16WTROQSJ9.eyJodHRwczovL2FwcERhdGEiOnsiYXBwQ2xpZW50SWQiOiJjN2U1MDU4NGRhMDM4MmFlY2RmMWEzMzQ1OTFmZmQzOCJ9LCJodHRwczovL2FjY291bnRTbHVnIjoibW9udGVjYXJsbyIsImh0dHBzOi8vdXNlckRldGFpbHMiOnsiaWQiOjgwOCwidXNlclR5cGUiOiJkZWZhdWx0IiwiZW1haWwiOiJhcHB1c2VyMjFAZXNob3Bib3guY29tIn0sImh0dHBzOi8vYWNjb3VudHMiOlsibW9udGVjYXJsbyJdLCJodHRwczovL3dhcmVob3VzZXMiOltdLCJodHRwczovL3BhcnRuZXJzIjpbXSwiaXNzIjoiaHR0cHM6Ly9lc2hvcGJveC5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NWZlNDdkZjFhNGZhNmMwMDZmMTBjN2I2IiwiYXVkIjoiaHR0cHM6Ly93bXMubXllc2hvcGJveC5jb20iLCJpYXQiOjE2MDkxNTkxNjYsImV4cCI6MTYxMTc1MTE2NiwiYXpwIjoiUXpWTzdmSGsySFl4Mlk1YjNXRG9pRHVHZTR2Q3dqSFAiLCJzY29wZSI6InJlYWQ6b3JkZXJzIG9mZmxpbmVfYWNjZXNzIiwiZ3R5IjoicGFzc3dvcmQifQ.WIdaENzdkYY90VRv-9AEGwreD66tvGaOBug-9G5erhDvboihXpRevDFe1gZTfJdA-HYWOFadw8bqjoM8ZtUv0pJdOI2QA-rKRhfAAaZOdfZc9Tn3DhybZHT4Pmltthz4Cgz-T516F0CTj0VhcR-T-FGg6-qb1xtPB83lflLAa-Lrj7T3FRqA9yp2r9MLCEkBCzqlrKUpCvdeA5DFaCAb-J8gvPsf9rs9pu6lf2Y_1P1fNETZUk2wZ6tGAt0gQnga6zCkoYZ_Su9FseuRx6rq-1IHeSvvbWUcNkvkZN2X91eAqjSNzK7WtCs0ZATpR9m08bFuFO4XascGfptJnfxb5Q"
        },
        "order": {
            "carrier": "string",
            "order_date": 1635828975,
            "order_id": "string",
            "payment_method": "string",
            "po_amount": 0,
            "total_tax": 0,
            "po_number": "string",
            "po_date": 1635828975,
            "po_pdf_url": "string",
            "status": "enum (CANCELLED, CONFIRMED, PACKED, DISPATCHED, DELIVERED, READY_TO_DISPATCH)",
            "order_lines": [
                {
                    "item_details": {
                        "brand_name": "string",
                        "color": "string",
                        "ean": "string",
                        "item_code": "string",
                        "name": "string",
                        "size": "string"
                    },
                    "mrp": 0,
                    "item_base_price": 0,
                    "order_item_id": "string",
                    "quantity": 0,
                    "customer_cancelled_qty": 0,
                    "seller_cancelled_qty": 0,
                    "seller_short_picked_qty": 0,
                    "hsn": "string",
                    "tax_summary": {
                        "cess_amount": 0,
                        "cess_percentage": 0,
                        "cgst_amount": 0,
                        "cgst_percentage": 0,
                        "igst_amount": 0,
                        "igst_percentage": 0,
                        "sgst_amount": 0,
                        "sgst_percentage": 0,
                        "tcs_amount": 0,
                        "tcs_percentage": 0,
                        "gst_amount": 0
                    },
                    "po_line_amount": 0,
                    "total_tax": 0
                }
            ],
            "recipient_address": {
                "address_line_1": "string",
                "address_line_2": "string",
                "address_line_3": "string",
                "city": "string",
                "country": "string",
                "first_name": "string",
                "last_name": "string",
                "mobile": "string",
                "state": "string",
                "state_code": 0,
                "zipcode": "string",
                "gstin": "string"
            }
        }
    }
}

Step 2. Get WMS AccessToken from channel data in queue data, and prepare WMS Create Order request body by mapping the following keys.

WMS Create Order Keys	TataCliq Create Order Keys

WMS Create Order Keys	TataCliq Create Order Keys
externalChannelID	channelData.externalChannelID
customerOrderNumber
shipMethod	“STD“
orderDate	order.`order_date`
isCOD
paymentType	order.`payment_method`
shipChargeAmount
subtotal	sum of all items[].lineItemTotal
orderTotal	subtotal+shipChargeAmount
balanceDue	if COD then orderTotal else if Prepaid then 0
thirdPartyShipping	true
vendorOrderNumber	order.`order_id`
externalWarehouseID	channelData.location[]
taxAmount
shippingAddress.customerName	order.`recipient_address`.`first_name`+ order.`recipient_address`.`last_name`
shippingAddress.addressLine1	order.`recipient_address.address_line_1`
shippingAddress.addressLine2	order.`recipient_address.address_line_2+order.recipient_address.address_line_3`
shippingAddress.city	order.`recipient_address`.city
shippingAddress.postalCode	order.`recipient_address`.`zipcode`
shippingAddress.countryCode	order.`recipient_address`.country
shippingAddress.countryName	"INDIA"
shippingAddress.contactPhone	order.`recipient_address`.`mobile`
shippingAddress.state	order.`recipient_address`.`state`
billingAddress.customerName	order.`recipient_address`.`first_name`+ order.`recipient_address`.`last_name`
billingAddress.addressLine1	order.`recipient_address.address_line_1`
billingAddress.addressLine2	order.`recipient_address.address_line_2+order.recipient_address.address_line_3`
billingAddress.city	order.`recipient_address`.city
billingAddress.postalCode	order.`recipient_address`.`zipcode`
billingAddress.countryCode	order.`recipient_address`.country
billingAddress.countryName	"INDIA"
billingAddress.contactPhone	order.`recipient_address`.`mobile`
billingAddress.state	order.`recipient_address`.`state`
expectedShipDate
items[].lineItemSequenceNumber	order.`order_lines`[].`order_item_id`
items[].status	“CREATED“
items[].quantity	order. `order_lines`[].`quantity`
items[].itemID	order. `order_lines`[].`item_details`.`item_code`
items[].lineItemTotal	order.`order_lines`[].
items[].customerPrice	order.`order_lines`[].
items[].taxAmount	order.`order_lines`[].`total_tax`

Step 3. Call WMS CreateOrder API with AccessToken and request body.

WMS CreateOrder API

https://wms.eshopbox.com/api/order

Request Body

{
    "externalChannelID": "{{channelData.externalChannelID}}",
    "customerOrderNumber": "{{order.orderLine[0].packId}}",
    "shipMethod": "STD",
    "orderDate": "{{order.OrderDate}}",
    "isCOD": "{{order.OrderLine[0].isCOD}}",
    "paymentType": "{{order.paymentInfo[0].paymentMode}}",
    "shipChargeAmount": {{order.orderLine[].apportionedShippingCharge for each}},
    "subtotal": {{sum of all items[].lineItemTotal}},
    "orderTotal": {{subtotal + shipChargeAmount}},
    "balanceDue": {{if COD then orderTotal else if Prepaid then 0}},
    "thirdPartyShipping": true,
    "vendorOrderNumber": "{{order.orderNo}}",
    "externalWarehouseID": "{{channelData.location[order.orderLine[0].p1SlaveId]}}",
    "taxAmount": "0.0",
    "shippingAddress": {
        "customerName": "{{order.addressInfo.firstName + order.addressInfo.lastName}}",
        "addressLine1": "{{order.addressInfo.address1}}",
        "addressLine2": "{{order.addressInfo.address2}}",
        "city": "{{order.addressInfo.city}}",
        "postalCode": "{{order.addressInfo.pincode}}",
        "countryCode": "{{order.addressInfo.country}}",
        "countryName": "India",
        "contactPhone": {{order.addressInfo.phoneNo}},
        "email": "{{order.addressInfo.emailID}}",
        "state": "{{order.addressInfo.state}}"
    },
    "billingAddress": {
        "customerName": "{{order.addressInfo.firstName + order.addressInfo.lastName}}",
        "addressLine1": "{{order.addressInfo.address1}}",
        "addressLine2": "{{order.addressInfo.address2}}",
        "city": "{{order.addressInfo.city}}",
        "postalCode": "{{order.addressInfo.pincode}}",
        "countryCode": "{{order.addressInfo.country}}",
        "countryName": "India",
        "contactPhone": {{order.addressInfo.phoneNo}},
        "email": "{{order.addressInfo.emailID}}",
        "state": "{{order.addressInfo.state}}"
    },
    "expectedShipDate": "{{order.orderLine[0].shipByDate}}",
    "items": [
        {
            "lineItemSequenceNumber": "{{order.orderLine[].transactionId}}",
            "status": "CREATED",
            "quantity": "1",
            "itemID": "{{order. orderLine[].articleNumber}}",
            "lineItemTotal": "{{order.orderLine[].apportionedPrice}}",
            "customerPrice": "{{order.orderLine[].price}}",
            "customerOrderItemID": "{{order.orderLine[].packId}}",
            "discount": "{{order.orderLine[].(coupon[].couponValue 
                          +promotionInfo[].promotionValue)}}",
            "isGift": "{{order.orderLine[].isaGift (N->0, Y->1)}}",
            "giftMessage": "{{order.orderLine[].giftMessage}}",
            "giftWrapCharges": "{{order.orderLine[].giftPrice}}",
            "taxRate": "{{order.orderLine[].taxValue}}",
            "taxAmount": "0.0",
            "productAdditionalInfo": {
                "deliveryMode": {{order.orderLine[].deliveryMode}},
                "transportMode": {{order.orderLine[].transportMode}}
            }
        }
    ]
}

Response Body from WMS

{
    "WMSResponse": {
        "promiseDeliveryDate": null,
        "vendorOrderNumber": "227119-141-911289",
        "orderSiteID": null,
        "expectedShipDate": "2021-03-13 17:00:00",
        "created_at": "2022-07-05 15:45:04",
        "customerOrderNumber": "227119-141-911289",
        "dispatchAfterDate": null,
        "paymentType": "Prepaid",
        "isCOD": "0",
        "integrationType": "0",
        "updated_at": "2022-07-05 15:45:04",
        "thirdPartyShipping": true,
        "id": 42668899,
        "channelLabel": null,
        "onHold": false,
        "balanceDue": 0,
        "externalChannelID": "CH5811",
        "expectedDeliveryDate": null,
        "orderTotal": 3299,
        "subtotal": 3299,
        "shipMethod": "STD",
        "shippingAddress": {
            "city": "Mumbai",
            "countryCode": "IN",
            "postalCode": "400083",
            "addressLine1": "corsaspec, Kaliveetil mall, amaravila",
            "addressLine2": null,
            "state": "27",
            "countryName": "INDIA",
            "contactPhone": "9751500171",
            "customerName": "Sicin Pious",
            "email": "NA"
        },
        "billingAddress": {
            "city": "Mumbai",
            "countryCode": "IN",
            "postalCode": "400083",
            "addressLine1": "DUMMY_STREET_NAMEDUMMY_STREET_NO",
            "addressLine2": null,
            "state": "27",
            "countryName": "INDIA",
            "contactPhone": "9751500171",
            "customerName": "Sicin Pious",
            "email": "cisinpious@gmail.com"
        },
        "taxAmount": 0,
        "orderDate": "2021-03-13 10:00:57",
        "items": [
            {
                "quantity": 1,
                "giftMessage": "null",
                "cancellationReason": "",
                "orderItemID": "227119-141-911289-23920766",
                "cancellationTime": "0000-00-00 00:00:00",
                "discount": 0,
                "giftLabelContent": "",
                "lineItemTotal": 3299,
                "customerPrice": 3299,
                "original_order_item_id": null,
                "productName": "tata cliq product",
                "itemID": "00340213023",
                "taxRate": 18,
                "lineItemSequenceNumber": "1111100111988889",
                "sku": "BBSHOCL35755_4",
                "taxAmount": 0
            }
        ],
        "shipChargeAmount": 0
    }
}

Apps and Automations

Create order (+pull flow)

Related content