Following topics are covered within this API doc:
\nNOTE:
\nGet Authorization Token API
\nThis api is used to authorized and get token so you can access further routes.
\nBody Params
\n","urlObject":{"path":["api","v1","manual","authentication",""],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e27281d5-aa30-4d5e-b9bb-cc9da2e6edd4"}],"id":"f8ca2464-4e12-42bc-a23b-29ad57647ec2","description":"Please use the authentication api to generate the auth token which is listed below.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret token in publicly accessible areas such as GitHub, client-side code, and so forth.
\nSteps To Use Token:
\nWebhook Request Body
\n","urlObject":{"host":["{{YOUR_SERVER_ENDPOINT}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7344ce40-32a3-4a6b-b23f-5aabb3c00adc"}],"id":"b64a8d29-dda6-497d-97df-be9f33864119","description":"Webhooks can be setup to receive order status updates.
\nAuthentication Headers
\nAuth headers will have key and value that client needs, usually to verify the authenticity of webhook request.
\nNote: Auth headers can be setup by contacting our intergation team
\n","_postman_id":"b64a8d29-dda6-497d-97df-be9f33864119"},{"name":"Create Order","id":"a8dcbe43-8cff-42dc-8e4b-85916fa2df07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY2NDE3MzQyOCwiZXhwIjoxNjY2NzY1NDI4fQ.e0BY61BKFL7H2ETrCidQ9_mT6Z2yl1E64ergDX6MgKA","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"YSP231\",\n \"paymentMethod\": \"prepaid\",\n \"weight\": 10,\n \"firstName\": \"Jeevan\",\n \"lastName\": \"Prakash\",\n \"phone\": \"+919912345678\",\n \"email\": \"jeevan.prakash@gmail.com\",\n \"address1\": \"Connaught Place\",\n \"address2\": \"ABL\",\n \"city\": \"New Delhi\",\n \"state\": \"Delhi\",\n \"zip\": \"110001\",\n \"items\": [\n {\n \"name\": \"Gift Pack Test\",\n \"quantity\": 1,\n \"price\": 10000,\n \"sku\": \"GIFTPACK\",\n \"discount\": 0\n }\n ],\n \"shippingPrice\": 0,\n \"awb\": \"\",\n \"awbPartner\": \"\",\n \"shippingLabelUrl\": \"\",\n \"invoiceUrl\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order","description":"Create Order API
\nThis function is used to create order and you can provide fulfilment details while creating the order
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","order"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8dcbe43-8cff-42dc-8e4b-85916fa2df07"},{"name":"Update Order","id":"45b6a4f6-960d-449d-b708-9842d213128f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shopOrderId\": \"YSP23\",\n \"externalOrderId\": \"e8ee041b-99d1-4f7c-97c4-5c3401dd76a2\",\n \"paymentMethod\": \"prepaid\",\n \"weight\": 10,\n \"quantity\": 1,\n \"shippingAddress\": {\n \"firstName\": \"Jeevan\",\n \"lastName\": \"Prakash\",\n \"phone\": \"+919912345678\",\n \"email\": \"jeevan.prakash@gmail.com\",\n \"address1\": \"Connaught Place\",\n \"address2\": \"ABL\",\n \"city\": \"New Delhi\",\n \"state\": \"Delhi\",\n \"zip\": \"110001\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order","description":"Update Order API
\nThis function is used to update the order details, you can specify only those fields which you would like to update
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","order"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45b6a4f6-960d-449d-b708-9842d213128f"},{"name":"Fetch Order Details","id":"764241ea-0ed7-4bd4-86b4-abef067a35e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"records\" : 1,\n \"pageNumber\" : 1\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order/find","description":"Fetch Order API
\nThis api is used to fetch order data with pagination, order will contain all necessary data that order have like billingAddress, shippingAddress, customerAddress, invoiceDetails(If order is RTS)
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","order","find"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8c9890ff-d24b-46b4-86a2-01fd9aaab5ad","name":"Fetch Order API","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"records\" : 1,\n \"pageNumber\" : 1\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order/find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 12:26:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3765"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"RateLimit-Limit","value":"100"},{"key":"RateLimit-Remaining","value":"98"},{"key":"RateLimit-Reset","value":"436"},{"key":"ETag","value":"W/\"eb5-fg2+CH26WG42sey5rDrte8MoELI\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Order Fetched\",\n \"order\": [\n {\n \"id\": \"fa427d00-6143-42f1-b66d-dbdb9ed4b840\",\n \"createdAt\": \"2022-09-28T09:36:38.203Z\",\n \"updatedAt\": \"2022-09-28T09:36:38.000Z\",\n \"deletedAt\": null,\n \"shopType\": \"manual\",\n \"companyId\": \"a5e6439c-b0d9-4185-be82-42b5a4d31a83\",\n \"weight\": 90000,\n \"weightUnit\": \"g\",\n \"quantity\": 1000,\n \"shippingPackageCode\": \"test\",\n \"customerId\": \"f9d82ec2-99db-4fdc-ac52-fd560c2e0a74\",\n \"shipper\": null,\n \"customerAddressId\": \"d0c3cc74-e59a-4646-8124-34db0006a217\",\n \"shippingFirstName\": \"Jeevan\",\n \"shippingLastName\": \"Prakash\",\n \"shippingEmail\": \"jeevan.prakash@gmail.com\",\n \"shippingPhone\": \"+919968967608\",\n \"shippingPincode\": \"110001\",\n \"shippingCoordinate\": null,\n \"shippingState\": \"Delhi\",\n \"shippingAddressId\": \"ffd28519-22e9-4888-a597-7fc31dcd2df2\",\n \"subTotal\": 8474576.271186441,\n \"total\": 7474576.271186441,\n \"totalTax\": 1345423.7288135595,\n \"totalDiscount\": 1000000,\n \"finalPrice\": 10001,\n \"shippingPrice\": 100,\n \"shippingCost\": 0,\n \"returnShippingCost\": 0,\n \"codCharge\": 0,\n \"totalFees\": 0,\n \"taxInfo\": [\n {\n \"rate\": 18,\n \"label\": \"sgst\",\n \"amount\": 672711.8644067798\n },\n {\n \"rate\": 18,\n \"label\": \"cgst\",\n \"amount\": 672711.8644067798\n }\n ],\n \"paymentMode\": \"prepaid\",\n \"externalOrderId\": \"YSP50\",\n \"shopOrderId\": \"YSP50\",\n \"invoiceId\": null,\n \"orderId\": \"f978cf52-36dc-4bc6-8ffb-3b60a357e30e\",\n \"referenceTrackingId\": null,\n \"invoiceUrl\": null,\n \"shippingLabelUrl\": null,\n \"tat\": null,\n \"deliveryAwb\": null,\n \"deliveryPartnerId\": null,\n \"deliveryAwbGenTs\": null,\n \"returnAwb\": null,\n \"returnPartnerId\": null,\n \"returnAwbGenTs\": null,\n \"zones\": null,\n \"zone\": null,\n \"status\": \"PLACED\",\n \"gstNumber\": \"33AAICB7073test\",\n \"ewayBill\": null,\n \"purchaseOrderNumber\": null,\n \"warehouseId\": \"2961d638-3e97-4e07-b550-58d84357b335\",\n \"codRemittanceId\": null,\n \"isb2bOrder\": false,\n \"pickupAddress\": {\n \"id\": \"2961d638-3e97-4e07-b550-58d84357b335\",\n \"createdAt\": \"2022-04-21T07:09:48.984Z\",\n \"updatedAt\": \"2022-04-21T07:09:48.984Z\",\n \"deletedAt\": null,\n \"firstName\": \"Test-Bangalore-WH\",\n \"lastName\": \"\",\n \"email\": null,\n \"phone\": \"9686655876\",\n \"addressType\": null,\n \"addressLine1\": \"K-4/41, Mohan Garden, Uttam Nagar\",\n \"addressLine2\": \"\",\n \"landmark\": \"LandMark\",\n \"city\": \"Delhi\",\n \"state\": \"Delhi\",\n \"pincode\": \"110059\",\n \"country\": \"India\",\n \"coordinate\": null,\n \"addressPurpose\": null,\n \"companyId\": null,\n \"GSTIN\": null\n },\n \"customerAddress\": {\n \"id\": \"d0c3cc74-e59a-4646-8124-34db0006a217\",\n \"createdAt\": \"2022-09-28T04:06:38.167Z\",\n \"updatedAt\": \"2022-09-28T04:06:38.167Z\",\n \"deletedAt\": null,\n \"firstName\": \"Jeevan\",\n \"lastName\": \"Prakash\",\n \"email\": null,\n \"phone\": \"+919968967608\",\n \"addressType\": \"Home\",\n \"addressLine1\": \"Connaught Place\",\n \"addressLine2\": \"ABL\",\n \"landmark\": null,\n \"city\": \"New Delhi\",\n \"state\": \"Delhi\",\n \"pincode\": \"110001\",\n \"country\": \"India\",\n \"coordinate\": null,\n \"addressPurpose\": \"customer\",\n \"companyId\": \"a5e6439c-b0d9-4185-be82-42b5a4d31a83\",\n \"GSTIN\": null\n },\n \"customerReturnAddress\": null,\n \"items\": [\n {\n \"id\": \"19bea019-e2f2-4e5d-aae0-07e7b8e84a50\",\n \"createdAt\": \"2022-09-28T04:06:38.214Z\",\n \"updatedAt\": \"2022-09-28T04:06:38.214Z\",\n \"deletedAt\": null,\n \"catalogueId\": \"0251dbff-ba66-45cc-9328-911b36e6f022\",\n \"title\": \"Pratham-208 Combo\",\n \"quantity\": 1000,\n \"returnQuantity\": 0,\n \"variantId\": \"5f4453ab-8fcd-4bf5-89fc-b01ffebd80b6\",\n \"productId\": \"P-208\",\n \"sku\": \"P-208\",\n \"wsinMapping\": {\n \"AB12345\": 1\n },\n \"hsnCode\": \"49011010\",\n \"subTotal\": 8474576.271186441,\n \"total\": 7474576.271186441,\n \"totalTax\": 1345423.7288135595,\n \"totalDiscount\": 1000000,\n \"finalPrice\": 8820000,\n \"rate\": 8474.57627118644,\n \"taxInfo\": [\n {\n \"rate\": 18,\n \"label\": \"sgst\",\n \"amount\": 672711.8644067798\n },\n {\n \"rate\": 18,\n \"label\": \"cgst\",\n \"amount\": 672711.8644067798\n }\n ],\n \"splitOrderId\": \"fa427d00-6143-42f1-b66d-dbdb9ed4b840\"\n }\n ],\n \"trails\": [\n {\n \"id\": \"433d4c2b-8a60-4545-9998-1f906a7b075a\",\n \"createdAt\": \"2022-09-28T09:36:38.213Z\",\n \"updatedAt\": \"2022-09-28T09:36:38.213Z\",\n \"deletedAt\": null,\n \"splitOrderId\": \"fa427d00-6143-42f1-b66d-dbdb9ed4b840\",\n \"orderStatus\": \"PLACED\",\n \"description\": \"Order Placed\",\n \"return\": false,\n \"city\": null,\n \"dnHash\": \"2c18ec5ec4bc923c9ff54f2554c377f4f930b516c6952814becafe9e4321e0dd\"\n }\n ]\n }\n ],\n \"currentCount\": 2406\n}"}],"_postman_id":"764241ea-0ed7-4bd4-86b4-abef067a35e8"},{"name":"Create Order (Ingress)","id":"8f788a39-2688-49e4-ae6f-367b9f8a9c8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-webhook-signature","value":"TWG6p2rEnlN/3dQdFD2ZnDaWey2CBNrs/0wZEjf3AJg=","type":"text"},{"key":"x-webhook-source","value":"https://custom.shop.com/","type":"text"},{"key":"x-webhook-id","value":"webhook_id","type":"text"},{"key":"x-webhook-topic","value":"order/create","type":"text"}],"body":{"mode":"raw","raw":"{\n \"weight\": 100,\n \"quantity\": 10,\n \"platformOrderId\": \"order_id\",\n \"shopOrderId\": \"shop_order_id\",\n \"createdAt\": \"2021-07-25T18:58:06.886Z\",\n \"updatedAt\": \"2021-07-25T18:58:06.886Z\",\n \"paymentMethod\": \"cod\",\n \"items\": [\n {\n \"productId\": \"product_id\",\n \"variantId\": \"variant_id\",\n \"name\": \"item_name\",\n \"quantity\": 3,\n \"sku\": \"item_SKU\",\n \"price\": {\n \"subTotal\": 100,\n \"total\": 1000,\n \"totalTax\": 100,\n \"totalDiscount\": 100,\n \"finalPrice\": 100,\n \"rate\": 2.5,\n \"taxInfo\": [\n {\n \"label\": \"IGST\",\n \"percentage\": 2.5,\n \"amount\": 100\n }\n ]\n }\n }\n ],\n \"price\": {\n \"subTotal\": 100,\n \"total\": 100,\n \"totalTax\": 10,\n \"totalDiscount\": 10,\n \"finalPrice\": 100,\n \"totalFees\": 0,\n \"totalShipping\": 9,\n \"taxInfo\": {\n \"label\": \"IGST\",\n \"percentage\": 2.5,\n \"amount\": 100\n }\n },\n \"shippingAddress\": {\n \"firstName\": \"shipping_firsT_name\",\n \"lastName\": \"shipping_last_name\",\n \"email\": \"shippingmeail@gmail.ccom\",\n \"phone\": \"+91-9999900113\",\n \"address1\": \"shipping address line1\",\n \"address2\": \"shipping address line2\",\n \"city\": \"shipping city\",\n \"state\": \"shipping state\",\n \"country\": \"shipping country\",\n \"pincode\": \"110001\"\n },\n \"billingAddress\": {\n \"firstName\": \"billing_firsT_name\",\n \"lastName\": \"billing_last_name\",\n \"email\": \"billingmeail@gmail.ccom\",\n \"phone\": \"+91-9999900113\",\n \"address1\": \"billing address line1\",\n \"address2\": \"billing address line2\",\n \"city\": \"billing city\",\n \"state\": \"billing state\",\n \"country\": \"billing country\",\n \"pincode\": \"110001\"\n },\n \"customer\": {\n \"firstName\": \"customer_first_name\",\n \"lastName\": \"customer_last_name\",\n \"email\": \"customer@gmail.com\",\n \"phone\": \"customer_phone\",\n \"address\": {\n \"firstName\": \"customer_first_name\",\n \"lastName\": \"customer_last_name\",\n \"email\": \"tset@asdsa.com\",\n \"phone\": \"customer_phone\",\n \"address1\": \"customer_address_1\",\n \"address2\": \"customer_address_2\",\n \"city\": \"customer city\",\n \"state\": \"customer state\",\n \"country\": \"customer country\",\n \"pincode\": \"110001\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{INGRESS_URL}}/api/ingress/create-order","description":"Create Order API Using Ingress
\nThis function is used to create order through ingress service. This is more secure way to create order.
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","ingress","create-order"],"host":["{{INGRESS_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f788a39-2688-49e4-ae6f-367b9f8a9c8a"},{"name":"Update Order (Ingress)","id":"d83406dc-1350-488d-99d2-6084e7323dbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-webhook-signature","value":"vIlCoJCZpP0Cs5Iwak9vo0yNqTsgmjNmrncICwmafsI=","type":"text"},{"key":"x-webhook-source","value":"https://custom.shop.com/","type":"text"},{"key":"x-webhook-id","value":"webhook_id","type":"text"},{"key":"x-webhook-topic","value":"order/update","type":"text"}],"body":{"mode":"raw","raw":"{\n \"weight\": 100,\n \"platformOrderId\": \"asdsd\",\n \"shopOrderId\": \"asdsad\",\n \"externalOrderId\": \"order_id\",\n \"quantity\": 10,\n \"createdAt\": \"2021-07-25T18:58:06.886Z\",\n \"updatedAt\": \"2021-07-25T18:58:06.886Z\",\n \"paymentMethod\": \"cod\",\n \"items\": [\n {\n \"productId\": \"product_id\",\n \"variantId\": \"variant_id\",\n \"name\": \"item_name\",\n \"quantity\": 12,\n \"sku\": \"item_SKU\",\n \"price\": {\n \"subTotal\": 100,\n \"total\": 1000,\n \"totalTax\": 100,\n \"totalDiscount\": 100,\n \"finalPrice\": 100,\n \"rate\": 2.5,\n \"taxInfo\": [\n {\n \"label\": \"IGST\",\n \"percentage\": 2.5,\n \"amount\": 100\n }\n ]\n }\n }\n ],\n \"price\": {\n \"subTotal\": 100,\n \"total\": 100,\n \"totalTax\": 10,\n \"totalDiscount\": 10,\n \"finalPrice\": 100,\n \"totalFees\": 100,\n \"totalShipping\": 100,\n \"taxInfo\": {\n \"label\": \"IGST\",\n \"percentage\": 2.5,\n \"amount\": 100\n }\n },\n \"shippingAddress\": {\n \"firstName\": \"shipping_firsT_name\",\n \"lastName\": \"shipping_last_name\",\n \"email\": \"shippingmeail@gmail.ccom\",\n \"phone\": \"+91-9999900113\",\n \"address1\": \"shipping address line1\",\n \"address2\": \"shipping address line2\",\n \"city\": \"shipping city\",\n \"state\": \"shipping state\",\n \"country\": \"shipping country\",\n \"pincode\": \"110001\"\n },\n \"billingAddress\": {\n \"firstName\": \"billing_firsT_name\",\n \"lastName\": \"billing_last_name\",\n \"email\": \"billingmeail@gmail.ccom\",\n \"phone\": \"+91-9999900113\",\n \"address1\": \"billing address line1\",\n \"address2\": \"billing address line2\",\n \"city\": \"billing city\",\n \"state\": \"billing state\",\n \"country\": \"billing country\",\n \"pincode\": \"110001\"\n },\n \"customer\": {\n \"firstName\": \"customer_first_name\",\n \"lastName\": \"customer_last_name\",\n \"email\": \"customer@gmail.com\",\n \"phone\": \"customer_phone\",\n \"address\": {\n \"firstName\": \"customer_first_name\",\n \"lastName\": \"customer_last_name\",\n \"email\": \"customer_email@gmail.com\",\n \"phone\": \"customer_phone\",\n \"address1\": \"customer_address_1\",\n \"address2\": \"customer_address_2\",\n \"city\": \"customer city\",\n \"state\": \"customer state\",\n \"country\": \"customer country\",\n \"pincode\": \"110001\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{INGRESS_URL}}/api/ingress/update-order","description":"Update Order API Using Ingress
\nThis function is used to update order through ingress service. This is more secure way to update order.
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","ingress","update-order"],"host":["{{INGRESS_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d83406dc-1350-488d-99d2-6084e7323dbf"}],"id":"0ddfedb3-7ba6-40e0-b7ed-c87cfc86ebf7","description":"This folder contains APIs which are related to Order Module.
\n","_postman_id":"0ddfedb3-7ba6-40e0-b7ed-c87cfc86ebf7"},{"name":"Catalog","item":[{"name":"Create Catalogue","id":"bb5f33f5-aaa1-4518-99ff-6df8e7eb9a98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"category\": \"Food\",\n \"length\": 10,\n \"breadth\": 10,\n \"height\": 10,\n \"weight\": 10,\n \"sgst\": 10,\n \"cgst\": 10,\n \"igst\": 10,\n \"utgst\": 10,\n \"hsnCode\": \"08071900\",\n \"price\": 1000,\n \"itemName\": \"YSP MANUAL\",\n \"productId\": \"YSP22222IOP\",\n \"variantId\": \"YSP22222IOP\",\n \"sku\": \"YSPMANUAL2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/catalogue","description":"Create Catalogue API
\nThis api is used to create catalogue(Item).
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","catalogue"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb5f33f5-aaa1-4518-99ff-6df8e7eb9a98"},{"name":"Update Catalogue","id":"0b22eb92-4b43-4639-960a-229027775410","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"productId\": \"YSP22222IOP\",\n \"variantId\": \"YSP22222IOP\",\n \"category\": \"Food\",\n \"length\": 10,\n \"breadth\": 10,\n \"height\": 10,\n \"weight\": 10,\n \"hsnCode\": \"08071900\",\n \"price\": 1000,\n \"itemName\": \"YSP MANUAL\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/catalogue","description":"Update Catalogue API
\nThis api is used to update the catalogue and it will update only those fields which you have passed in body
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","catalogue"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b22eb92-4b43-4639-960a-229027775410"},{"name":"Fetch Catalogue","id":"e02219cb-61ab-421d-a7c2-9aa8ad15ad82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"records\" : 1,\n \"pageNumber\" : 1\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/catalogue/find","description":"Fetch Catalogue API
\nThis api is used to fetch the catalogue data with pagination
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","catalogue","find"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e02219cb-61ab-421d-a7c2-9aa8ad15ad82"},{"name":"Create Catalogue (Ingress)","id":"eb97aec7-c152-4e1f-bc86-81e4171e3fa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-webhook-signature","value":"+R8wcZ+f+mcsA8VaANfW1Cr3uK3Pu5/jAGGdDEzMhlM=","type":"text"},{"key":"x-webhook-source","value":"https://custom.shop.com/","type":"text"},{"key":"x-webhook-id","value":"webhook_id","type":"text"},{"key":"x-webhook-topic","value":"product/create","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"product_id\",\n \"title\": \"product_title\",\n \"variants\": [\n {\n \"id\": \"12312312\",\n \"title\": \"123123123\",\n \"weight\": 100,\n \"taxable\": true,\n \"isActive\": true,\n \"sku\": \"VARIANT_SKU\",\n \"price\": 100.00,\n \"inventoryQuantity\": 100,\n \"hsnCode\": \"variant_hsn\",\n \"images\": [\n \"https://test.com\"\n ],\n \"dimensions\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10\n },\n \"createdAt\": \"2021-07-25T18:58:06.886Z\",\n \"updatedAt\": \"2021-07-25T18:58:06.886Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{INGRESS_URL}}/api/ingress/create-product","description":"Create Product API Using Ingress
\nThis function is used to create product through ingress service. This is more secure way to create product.
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","ingress","create-product"],"host":["{{INGRESS_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb97aec7-c152-4e1f-bc86-81e4171e3fa5"},{"name":"Update Catalogue (Ingress)","id":"be3a57e6-68bd-46a5-956e-4f27eb6e284d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-webhook-signature","value":"gXQP/l2+KJ9BvGQKUgbYz2/sxDWu5Dx0NG2SJWw3dAU=","type":"text"},{"key":"x-webhook-source","value":"https://custom.shop.com/","type":"text"},{"key":"x-webhook-id","value":"webhook_id","type":"text"},{"key":"x-webhook-topic","value":"product/update","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"product_id\",\n \"title\": \"product_title\",\n \"variants\": [\n {\n \"id\": \"variant_id\",\n \"title\": \"variant_title\",\n \"weight\": \"variant_weight\",\n \"taxable\": true,\n \"isActive\": true,\n \"sku\": \"VARIANT_SKU\",\n \"price\": 100.00,\n \"inventoryQuantity\": 100,\n \"hsnCode\": \"variant_hsn\",\n \"images\": [\n \"https://test.com\"\n ],\n \"createdAt\": \"2021-07-25T18:58:06.886Z\",\n \"updatedAt\": \"2021-07-25T18:58:06.886Z\",\n \"dimensions\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{INGRESS_URL}}/api/ingress/update-product","description":"Update Product API Using Ingress
\nThis function is used to update product through ingress service. This is more secure way to update product.
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","ingress","update-product"],"host":["{{INGRESS_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be3a57e6-68bd-46a5-956e-4f27eb6e284d"}],"id":"2df55822-0755-4457-9899-7a7310015a65","description":"This folder contains APIs which are related to Catalogue Module.
\n","_postman_id":"2df55822-0755-4457-9899-7a7310015a65"},{"name":"Fulfillment","item":[{"name":"Get FulFillment Detail API","id":"acea474e-afc7-41a2-a2fe-2cbe8ab3a910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\" : \"223a3709-9ee5-4ecb-9df8-69f9464f1019\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order/fulfillment","description":"Fetch Order Fulfilment detail API
\nThis api is used to fetch the fulfilment details of the order. This API will give you an error if order is not RTS.
\nHeader Params
\nBody Params
\n","urlObject":{"path":["api","v1","manual","order","fulfillment"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"00dce0c7-8cd5-4c40-b3b9-98e76f631190","name":"Get FulFillment Detail API","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6ImQ5MGJkZWY1LTE0YTEtNDVkZS1hNWQ4LTBjMjc2OGZiNjhlNCIsImlhdCI6MTY0OTM5OTU4MCwiZXhwIjoxNjgwOTM1NTgwfQ.r7-XZAkMdrJPFVuFdUePWoGRlWc9G0DnsicagZJglyQ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\" : \"223a3709-9ee5-4ecb-9df8-69f9464f1019\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/manual/order/fulfillment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Sep 2022 12:48:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2031"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"RateLimit-Limit","value":"100"},{"key":"RateLimit-Remaining","value":"94"},{"key":"RateLimit-Reset","value":"827"},{"key":"ETag","value":"W/\"7ef-LfrKHlP/WOzRVPhM67DOdzKuPBg\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Order Fetched\",\n \"order\": {\n \"id\": \"1bc1b8b8-a1b9-4a19-9d22-94e00521fb77\",\n \"deliveryAwb\": \"ZZC1C110000947\",\n \"deliveryPartnerId\": \"WherehouseLightning\",\n \"status\": \"IN_TRANSIT\",\n \"invoice\": {\n \"id\": \"1b260dd5-3e08-4501-801d-d8b875ff0232\",\n \"orderId\": \"1bc1b8b8-a1b9-4a19-9d22-94e00521fb77\",\n \"invoiceId\": \"BETEGUR012300016\",\n \"invoiceUrl\": \"a5e6439c-b0d9-4185-be82-42b5a4d31a83/586fd612-b5cc-40cd-921d-42ba6c5b662f/2022/09/26/BETEGUR012300016-invoice4inch.pdf\",\n \"shippingUrl\": \"a5e6439c-b0d9-4185-be82-42b5a4d31a83/586fd612-b5cc-40cd-921d-42ba6c5b662f/2022/09/26/BETEGUR012300016-shipping.pdf\",\n \"index\": \"16\",\n \"warehouseId\": \"586fd612-b5cc-40cd-921d-42ba6c5b662f\",\n \"companyId\": \"a5e6439c-b0d9-4185-be82-42b5a4d31a83\",\n \"createdAt\": \"2022-09-26T04:10:46.701Z\",\n \"updatedAt\": \"2022-09-26T04:10:47.000Z\",\n \"deletedAt\": null,\n \"isb2bInvoice\": true\n },\n \"trails\": [\n {\n \"id\": \"3eb0240e-d6d5-451d-ae57-7ba257d7cf8c\",\n \"createdAt\": \"2022-09-26T09:40:42.034Z\",\n \"updatedAt\": \"2022-09-26T09:40:42.034Z\",\n \"deletedAt\": null,\n \"splitOrderId\": \"1bc1b8b8-a1b9-4a19-9d22-94e00521fb77\",\n \"orderStatus\": \"PLACED\",\n \"description\": \"Order Placed\",\n \"return\": false,\n \"city\": null,\n \"dnHash\": \"ff4b1643e836992903a156ff68127603aaee1ce62c430cbc5cb8c0426ada23a5\"\n },\n {\n \"id\": \"3f9b8d66-6313-4e4c-9a81-9f21a75adc7c\",\n \"createdAt\": \"2022-09-26T09:40:47.914Z\",\n \"updatedAt\": \"2022-09-26T09:40:47.914Z\",\n \"deletedAt\": null,\n \"splitOrderId\": \"1bc1b8b8-a1b9-4a19-9d22-94e00521fb77\",\n \"orderStatus\": \"READY_TO_SHIP\",\n \"description\": \"Ready to ship from VPO Wazirabad, near Union Bank, , Gurugram, Haryana, India having AWB ZZC1C110000947\",\n \"return\": false,\n \"city\": null,\n \"dnHash\": \"8579e77f2d116ecd9ab00e54d0f21747ae4bd891e6787cf98c8443e8a7c758c3\"\n },\n {\n \"id\": \"f5957836-4824-448e-90db-f416842672e8\",\n \"createdAt\": \"2022-09-26T09:41:16.000Z\",\n \"updatedAt\": \"2022-09-26T09:41:16.000Z\",\n \"deletedAt\": null,\n \"splitOrderId\": \"1bc1b8b8-a1b9-4a19-9d22-94e00521fb77\",\n \"orderStatus\": \"IN_TRANSIT\",\n \"description\": \"Order created by OMS request with AWB : ZZC1C110000947\",\n \"return\": false,\n \"city\": \"Delhi\",\n \"dnHash\": \"8d64c0246021c08ad96db88418d5e8e46195b0f3655052c1562a1c1296d1a069\"\n }\n ]\n }\n}"}],"_postman_id":"acea474e-afc7-41a2-a2fe-2cbe8ab3a910"}],"id":"31af7762-a542-47ba-9ddd-bee73e258735","_postman_id":"31af7762-a542-47ba-9ddd-bee73e258735","description":""},{"name":"Lightning","item":[{"name":"Obtain Access Token","id":"404caa04-4738-4e2d-b74b-e2eb8a3546a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\" : \"String\",\n \"password\" : \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/authenticate","description":"Route to Obtain the Access Token Required for All Request
\nBody Params
\n","urlObject":{"protocol":"https","path":["api","hms","authenticate"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"365d4dd4-cd3c-4954-9885-207c7feb0701","name":"Successfull Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\" : \"String\",\n \"password\" : \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/authenticate"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\" : true,\n \"accessToken\" : \"eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9lIENvZGVyIn0.5dlp7GmziL2QS06sZgK4mtaqv0_xX4oFUuTDh1zHK4U\"\n}"},{"id":"44bb0564-1b38-436a-b1d2-7c384b24f96b","name":"Unsuccessfull Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\" : \"String\",\n \"password\" : \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/authenticate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\" : false,\n \"message\" : \"Username Does not Exist / Incorrect Password\"\n}"}],"_postman_id":"404caa04-4738-4e2d-b74b-e2eb8a3546a2"},{"name":"Check Serviceability","id":"7f048b10-24e8-4278-8119-3a24f18134a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pincode\": \"122022\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/serviceability","description":"Route to check serviceability of lightning order
\n","urlObject":{"protocol":"https","path":["api","hms","order","serviceability"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"fec0cf68-10ce-4af8-92c8-5dfff6c744fe","name":"Successfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pincode\": \"122022\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/serviceability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true\n}\n"},{"id":"e4777c97-6a44-4a41-9b1b-3b1e1f060e53","name":"Unsuccessful Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pincode\": \"530068\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/serviceability"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : false\n}\n"}],"_postman_id":"7f048b10-24e8-4278-8119-3a24f18134a8"},{"name":"Create Lightning Order","id":"31ca761d-552c-43a6-8e97-aca60909ccaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"referenceId\": \"String\",\n \"quantity\": \"Number\",\n \"weight\": \"Number\",\n \"weightUnit\": \"String\",\n \"totalPrice\": \"Number\",\n \"reverse\": \"boolean\",\n \"paymentMethod\": \"String\",\n \"shippingAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"String\"\n },\n \"pickupAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"String\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/create","description":"Route to Create An Order With Wherehouse Lightning
\nYou can create a forward order and reverse order with this API. If reverse is true, shipping address is treated as customer address. By default, reverse is false.
\nHeader Params
\nBody Params
\n","urlObject":{"protocol":"https","path":["api","hms","order","create"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"1543105f-b32c-44ed-a251-acf3c75a2415","name":"Successfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"referenceId\": \"String\",\n \"quantity\": \"Number\",\n \"weight\": \"Number\",\n \"weightUnit\": \"String\",\n \"totalPrice\": \"Number\",\n \"reverse\": \"boolean\",\n \"paymentMethod\": \"String\",\n \"shippingAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"String\"\n },\n \"pickupAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"String\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/create"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true,\n \"message\" : \"Order Successfully Created\",\n \"awb\" : \"ZZC1X233323\",\n \"shippingLabelURL\": \"https://some-url.com/lightning/labels/WlpDMVgyMzMzMjM=.pdf\"\n}"},{"id":"22798d04-26e7-42dd-b6e5-ba54ae2352a9","name":"UnSuccessfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"referenceId\": \"String\",\n \"quantity\": \"Number\",\n \"weight\": \"Number\",\n \"weightUnit\": \"String\",\n \"totalPrice\": \"Number\",\n \"reverse\": \"boolean\",\n \"paymentMethod\": \"String\",\n \"shippingAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"Number\"\n },\n \"pickupAddress\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"landmark\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"country\": \"String\",\n \"pincode\": \"Number\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/create"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : false,\n \"message\" : \"Duplicate Reference Id / Order is Unservicable\"\n}"}],"_postman_id":"31ca761d-552c-43a6-8e97-aca60909ccaf"},{"name":"Track Orders","id":"0063f51c-f69d-4268-98e4-6d51ea754b90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awbs\" : [\"AWB000001\",\"AWB000002\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/track","description":"Route to Track An Array of AWBs
\nThis API allows you to track a maximum of 25 AWBs at a time
\nThese are the statuses that are available :
\n","urlObject":{"protocol":"https","path":["api","hms","order","track"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"8305ed1a-04b3-4e12-b989-bd31fb8c9530","name":"Successfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awbs\" : [\"AWB000001\",\"AWB000002\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/track"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true,\n \"ShipmentData\": [\n {\n \"awb\": \"AWB000001\",\n \"referenceId\": \"f0a7ffcf-d67b-4ccb-97a6-5c6f0c8211ce\",\n \"status\": \"UNDELIVERED\",\n \"trail\": [\n {\n \"id\": \"01e066e8-b851-456f-9e2f-a5aa911dd88e\",\n \"createdAt\": \"2022-07-11T23:59:01.632Z\",\n \"updatedAt\": \"2022-07-12T05:29:01.626Z\",\n \"status\": \"PLACED\",\n \"description\": \"Order created by OMS request with AWB : AWB000001\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"c582c736-7370-4bc6-916e-2d13071955b3\",\n \"createdAt\": \"2022-07-12T04:49:15.093Z\",\n \"updatedAt\": \"2022-07-12T10:19:15.089Z\",\n \"status\": \"IN_TRANSIT\",\n \"description\": \"Order with AWB: AWB000001 is assigned to driver: Test (9876543210) while in journey\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"58a6e28d-33ff-4892-8ff5-e0188e41125c\",\n \"createdAt\": \"2022-07-12T04:49:15.096Z\",\n \"updatedAt\": \"2022-07-12T10:19:15.091Z\",\n \"status\": \"OUT_FOR_DELIVERY\",\n \"description\": \"Order with AWB: AWB000001 is out for delivery by driver: Test (9876543210)\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"81bd99e5-0ae4-4941-b307-5f93349e024c\",\n \"createdAt\": \"2022-07-12T05:56:32.766Z\",\n \"updatedAt\": \"2022-07-12T11:26:32.762Z\",\n \"status\": \"UNDELIVERED\",\n \"description\": \"Order with AWB: AWB000001 marked undelivered by driver: Test (9876543210)\",\n \"city\": \"Delhi\"\n }\n ]\n },\n {\n \"awb\": \"AWB000002\",\n \"referenceId\": \"f0a7ffcf-d67b-4ccb-97a6-5c6f0c8211ce\",\n \"status\": \"DELIVERED\",\n \"trail\": [\n {\n \"id\": \"01e066e8-b851-456f-9e2f-a5aa911dd88e\",\n \"createdAt\": \"2022-07-11T23:59:01.632Z\",\n \"updatedAt\": \"2022-07-12T05:29:01.626Z\",\n \"status\": \"PLACED\",\n \"description\": \"Order created by OMS request with AWB : AWB000002\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"c582c736-7370-4bc6-916e-2d13071955b3\",\n \"createdAt\": \"2022-07-12T04:49:15.093Z\",\n \"updatedAt\": \"2022-07-12T10:19:15.089Z\",\n \"status\": \"IN_TRANSIT\",\n \"description\": \"Order with AWB: AWB000002 is assigned to driver: Test (9876543210) while in journey\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"58a6e28d-33ff-4892-8ff5-e0188e41125c\",\n \"createdAt\": \"2022-07-12T04:49:15.096Z\",\n \"updatedAt\": \"2022-07-12T10:19:15.091Z\",\n \"status\": \"OUT_FOR_DELIVERY\",\n \"description\": \"Order with AWB: AWB000002 is out for delivery by driver: Test (9876543210)\",\n \"city\": \"Delhi\"\n },\n {\n \"id\": \"81bd99e5-0ae4-4941-b307-5f93349e024c\",\n \"createdAt\": \"2022-07-12T05:56:32.766Z\",\n \"updatedAt\": \"2022-07-12T11:26:32.762Z\",\n \"status\": \"UNDELIVERED\",\n \"description\": \"Order with AWB: AWB000002 marked delivered by driver: Test (9876543210)\",\n \"city\": \"Delhi\"\n }\n ]\n }\n ]\n}\n"},{"id":"3ba7ab7b-5e4a-4e7c-9885-20f043eb163a","name":"Partial Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awbs\" : [\"AWB000001\",\"AWB000002\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/track"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true,\n \"ShipmentData\": [\n {\n \"awb\": \"AWB000001\",\n \"referenceId\": \"f0a7ffcf-d67b-4ccb-97a6-5c6f0c8211ce\",\n \"status\": \"UNDELIVERED\"\n }\n ]\n}\n"}],"_postman_id":"0063f51c-f69d-4268-98e4-6d51ea754b90"},{"name":"Cancel Lightning Order","id":"fbd689cd-5379-4f6c-800a-3a0abab6f174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\",\n \"reason\": \"Cancel Reason (Optional)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/cancel","description":"Route to cancel lightning order
\n","urlObject":{"protocol":"https","path":["api","hms","order","cancel"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"bf142a68-9970-40da-9fb9-6722c722c6c1","name":"Successfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\",\n \"reason\": \"Cancel Reason (Optional)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true\n}\n"},{"id":"9976aa5c-bae6-4c2a-b9ac-7e82d005d9a9","name":"Partial Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\",\n \"reason\": \"Cancel Reason (Optional)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/cancel"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : false\n}\n"}],"_postman_id":"fbd689cd-5379-4f6c-800a-3a0abab6f174"},{"name":"Initiate Return","id":"b59e6653-0f5f-4f09-8e77-94e5791b2d57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/initiate-return","description":"Route to initiate a return for an order that is delivered through Wherehouse Lightning (order should be delivered). If you want to create pickup, use Create Lightning Order API with return property false.
\n","urlObject":{"protocol":"https","path":["api","hms","order","initiate-return"],"host":["oms","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"42f06bd9-cf2f-499a-9191-413c4904e1a2","name":"Successfull Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/initiate-return"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : true,\n \"message\" : \"Order Successfully Created\",\n \"awb\" : \"ZZC1X233323\"\n}"},{"id":"5caa67d9-4471-4d18-a93f-b85b78d84a73","name":"Partial Response","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer TokenObtainedViaAuthenticate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"awb\": \"ABC1000000001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/hms/order/initiate-return"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" : false\n}\n"}],"_postman_id":"b59e6653-0f5f-4f09-8e77-94e5791b2d57"}],"id":"69b9c061-9f83-4824-a25b-0f1b58534949","description":"Overview:
\nThe API is used to interact with the lightning service of the Wherehouse.
\nAuthentication
\nThe authentication token is an alphanumeric code, unique to your Wherehouse account, can be used from any system to validate your API calls to access Wherehouse's resources. Wherehouse API uses JWT tokens for validation.
\nYou Should Use The authenticate Route to Obtain The Access Token Required in other routes
\nSteps To Use Token:
\nError Codes
\nAPI to generate Authorization Token.
\n","urlObject":{"protocol":"https","path":["api","v1","ums","external","entity","login"],"host":["ums","external","wherehouse","io"],"query":[],"variable":[]}},"response":[{"id":"67bcfa65-1d6e-402c-a4e5-ac1de67af8d4","name":"External Entity Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\" : \"memepaylater\",\n \"password\" : \"MEMEPayLater@12345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ums.external.wherehouse.io/api/v1/ums/external/entity/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Jan 2023 11:54:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"127"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"7f-Fb5WqTfI+JlToBkpSklqLfikrtk\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"auth_token\": \"{AUTH_TOKEN}\"\n}"}],"_postman_id":"7452f975-4ffa-4369-a1b5-1c088fa277ec"},{"name":"List Inventory ","id":"1d27284f-3149-44e7-95c6-0428ea2137bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"auth_token","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://oms.external.wherehouse.io/api/v1/external/inventory?page=1&records=10&userId=1f6791ec-d4fe-4f5c-a7d8-052deff696ba","description":"Params explained:
\nAPI response is paginated and hence page number and count of records is required in each request
\n","urlObject":{"protocol":"https","path":["api","v1","external","inventory"],"host":["oms","external","wherehouse","io"],"query":[{"key":"page","value":"1"},{"key":"records","value":"10"},{"key":"userId","value":"1f6791ec-d4fe-4f5c-a7d8-052deff696ba"}],"variable":[]}},"response":[{"id":"f652d58d-97d0-430c-94b4-776222c976a9","name":"List Inventory ","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"YOUR_AUTH_TOKEN","type":"text"}],"url":{"raw":"https://oms.external.wherehouse.io/api/v1/external/inventory?page=1&records=10&userId=1f6791ec-d4fe-4f5c-a7d8-052deff696be","protocol":"https","host":["oms","external","wherehouse","io"],"path":["api","v1","external","inventory"],"query":[{"key":"page","value":"1"},{"key":"records","value":"10"},{"key":"userId","value":"1f6791ec-d4fe-4f5c-a7d8-052deff696be"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Jan 2023 12:11:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"788"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"314-M03oBwGRaDJwhBJ9H1INnL68kLc\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"inventory\": [\n {\n \"name\": \"A2 Hallikar 5000ml\",\n \"wsin\": \"8906136780002\",\n \"currentStock\": \"1\"\n },\n {\n \"name\": \"Grounnut oil 5000ml\",\n \"wsin\": \"8906136780323\",\n \"currentStock\": \"0\"\n },\n {\n \"name\": \"Gir cow ghee 1000 ml\",\n \"wsin\": \"8906136781085\",\n \"currentStock\": \"12\"\n },\n {\n \"name\": \"Sunflower oil 500 ml\",\n \"wsin\": \"8906136781054\",\n \"currentStock\": \"6\"\n },\n {\n \"name\": \"Coconut oil 500 ml\",\n \"wsin\": \"8906136780521\",\n \"currentStock\": \"14\"\n },\n {\n \"name\": \"Gir Cow ghee 500 ml\",\n \"wsin\": \"8906136781078\",\n \"currentStock\": \"0\"\n },\n {\n \"name\": \"A2 hallikar cow ghee 250 ml\",\n \"wsin\": \"8906136780415\",\n \"currentStock\": \"17\"\n },\n {\n \"name\": \"Corriander Powder 100g\",\n \"wsin\": \"8906136780668\",\n \"currentStock\": \"16\"\n },\n {\n \"name\": \"Turmeric Powder 100g\",\n \"wsin\": \"8906136780651\",\n \"currentStock\": \"10\"\n },\n {\n \"name\": \"Red Chili 100g\",\n \"wsin\": \"8906136780675\",\n \"currentStock\": \"12\"\n }\n ],\n \"totalCount\": 35\n}"}],"_postman_id":"1d27284f-3149-44e7-95c6-0428ea2137bf"}],"id":"d4926d3f-2e70-46b6-a198-a55c0532a818","_postman_id":"d4926d3f-2e70-46b6-a198-a55c0532a818","description":""}],"event":[{"listen":"prerequest","script":{"id":"e86b3648-676f-4726-86bc-7b32c327e56d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f2522fd1-29db-4585-914e-f0be94a488de","type":"text/javascript","exec":[""]}}],"variable":[{"value":"https://oms.external.wherehouse.io","type":"string"}]}