![](\"https://logisy.s3.amazonaws.com/documentation_images/AbandonedCheckoutEvents.jpg\")
![\"alt](\"https://logisy.tech/apistatic/images/pragma_600.png\")
\n\nPragma is an automata designed for your e-commerce site's growth. It provides all the tools you would need to monitor your orders and increase profitability. Pragma can be integrated to your store via REST APIs and the following document explains the same.
\nGet started by registering with us. Once we confirm your account, you will be able to create an API token. This token needs to be sent via each request. Upon this, Pragma will communicate to your server via various APIs and webhooks. There are few javascript libraries that also need to be installed in your site for Pragma to work.
\nHere is a checklist of things that you need to take care of
\nCreate API token
\nImplement Abandoned Checkout APIs & webhooks
\nImplement Orders APIs & webhooks
\nImplement Products APIs & webhooks
\nImplement Coupons APIs & webhooks
\nInstall javascript libraries
\nPragma APIs and webhooks depend on various objects for server to server communication. Each object has been mentioned below along with their properties. You can also have a basic understanding of their relationships by looking at the ER diagram below.
\n![\"alt](\"https://logisy.s3.amazonaws.com/documentation_images/ERDiagram.jpg\")
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Version 1.0","slug":"version-10"},{"content":"Introduction","slug":"introduction"},{"content":"Getting Started","slug":"getting-started"},{"content":"Objects","slug":"objects"}],"owner":"9962170","collectionId":"b1f86fc4-0e9e-4dd4-b70f-4b46dfbec65c","publishedId":"TVK5eMvX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"D35B56"},"publishDate":"2020-09-13T15:07:42.000Z"},"item":[{"name":"Addresses","item":[],"id":"95739247-3147-4214-84a3-381c9e585d72","description":"Addresses are created during the creation of a order or abandoned checkout object (see below for more info) and there is no direct way to interact with address objects. An address may represent a customer's default address, billing address or shipping address.
The following is the structure of the address object
{\n \"id\": \"4824720729506\",\n \"zip\": \"110000\",\n \"city\": \"New Delhi\",\n \"phone\": \"+919880000000\",\n \"country\": \"India\",\n \"default\": true,\n \"address1\": \"Address line 1\",\n \"address2\": \"Address line 2\",\n \"province\": \"Delhi\",\n \"country_code\": \"IN\",\n \"country_name\": \"India\",\n \"province_code\": \"DL\",\n \"latitude\": 76.99874,\n \"longitude\": 78.773522\n}\nLine items are basically a product's or a product variant's representation in an abandoned_checkout or an order object. Each line item represents one product / variant.
The following is the structure of the line_item object
product (see below)variant (see below){\n \"id\": \"2349854027448\",\n \"sku\": \"7JHD8893 BLUE STRIPE TEE SHIRT 04 M\",\n \"name\": \"Stripe Tee Shirt - M / Blue\",\n \"title\": \"Stripe Tee Shirt\",\n \"grams\": 1200,\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"quantity\": 2,\n \"product_id\": \"5684027447458\",\n \"variant_id\": \"36047249860194\"\n}\nCreate an Abandoned Object in Logisy by calling the following API.
\nabandoned_checkout obj): The abandoned_checkout obj (see above for reference)The following list of APIs/webhooks are provided by Logisy so that your system can push abandoned checkout related data and events to Logisy's.
\n","event":[{"listen":"prerequest","script":{"id":"7db9e16a-b24d-4c4b-aaeb-fe54096c2cc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"40acc29b-4710-424b-bca4-37c6c769a480","type":"text/javascript","exec":[""]}}],"_postman_id":"ebba611c-bfc1-425e-9a6f-a7925ef2634f"},{"name":"Client-side APIs / Webhooks","item":[{"name":"Abandoned Checkout API","id":"dcf8e322-89bc-4a64-a955-3a45d39f1067","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":"https://your-store.com/your-abandoned-checkout-api-url?id=14689130810850","description":"This API is required so that Logisy can pull abandoned_checkout data for one particular abandoned_checkout from your servers.
\nabandoned_checkout to be fetched200 OKabandoned_checkout obj): The abandoned_checkout which was queriedThe following list of APIs/webhooks needs to be implemented at the store's system so that abandoned checkout data can be queried or posted by Logisy as and when needed.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"e9186857-d084-4526-9ea6-ce574b19cb8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3fbd2fc-73a1-4557-acc3-d1162f6bf3e6","type":"text/javascript","exec":[""]}}],"_postman_id":"ed4ce667-e036-4b0a-8194-b8b86774c716"}],"id":"6ac69238-1f00-4719-b304-87dfa0fbab8c","description":"NOTE: All the following APIs/webhooks expect
\n200 OKas HTTP statuses. Anything else is consdered as an error and thus Logisy will re-try the webhooks for a maximum of three times with a gap of 1 min between each successive try. If your APIs still fail, Logisy will let you know via an email.
Abandoned checkouts are created when a customer leaves your site without completing an order. Meaning, the customer has added products in their cart but leaves the site just before completing the payment process.
\nWe let merchants decide when to trigger the Abandoned Checkout API based on their requirements. There is only one event related abandoned checkout which is mentioned in the diagram below.
The following is the structure of the abandoned_checkout Object.
ISO 8601 datetime str): Abandoned checkout creation timestampline_item****): This is a list of products a customer has added in their cart. It is represented by an array of line_itemsaddress obj, optional): Check the address object{\n \"id\": \"14689130810850\",\n \"note\": \"Some abandoned checkout related note\",\n \"tags\": \"some_tag,yet_another_tag\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"janedoe@somesite.com\",\n \"phone\": \"+919880000000\",\n \"created_at\": \"2020-09-12T13:53:17+05:30\",\n \"line_items\": [\n {\n \"id\": \"2349854027448\",\n \"sku\": \"7JHD8893 BLUE STRIPE TEE SHIRT 04 M\",\n \"name\": \"Stripe Tee Shirt - M / Blue\",\n \"title\": \"Stripe Tee Shirt\",\n \"grams\": 1200,\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"quantity\": 2,\n \"product_id\": \"5684027447458\",\n \"variant_id\": \"36047249860194\"\n },\n {\n \"id\": \"2349854027501\",\n \"sku\": \"7JHD8893 BLUE STRIPE TEE SHIRT 04 M\",\n \"name\": \"Stripe Tee Shirt - M / Green\",\n \"title\": \"Stripe Tee Shirt\",\n \"grams\": 1300,\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"quantity\": 1,\n \"product_id\": \"5684027447458\",\n \"variant_id\": \"36047249860194\"\n }\n ],\n \"source_name\": \"web\",\n \"currency\": \"INR\",\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"discount_codes\": [\n \"DIWALI123\",\n \"FLAT500OFF\"\n ],\n \"shipping_address\": {\n \"id\": \"4824720729506\",\n \"zip\": \"110000\",\n \"city\": \"New Delhi\",\n \"phone\": \"+919880000000\",\n \"country\": \"India\",\n \"default\": true,\n \"address1\": \"Address line 1\",\n \"address2\": \"Address line 2\",\n \"province\": \"Delhi\",\n \"country_code\": \"IN\",\n \"country_name\": \"India\",\n \"province_code\": \"DL\",\n \"latitude\": 76.99874,\n \"longitude\": 78.773522\n },\n \"abandoned_checkout_url\": \"https://yourstore.com/checkouts/14689130810850/recover\",\n \"device_id\": \"uisd67834iuiu5489\",\n \"referring_site\": \"https://facebook.com/some-campaign/\",\n \"browser_ip\": \"192.168.0.145\",\n \"brand_name\": \"Brand X\" \n}\n\nCreate an Order Object in Logisy by calling the following API.
\norder obj): The order object (see above for reference)Marks an Order Object as cancelled.
\nISO 8601 datetime str): The timestamp when the order was cancelledUpdate the fulfillment details (shipment details) of an Order Object in Logisy.
\nline_item ids which got fulfilled by your store. This parameter needs to be provided as Logisy supports partial fulfillment as wellThe following list of APIs/webhooks are provided by Logisy so that your system can push order related data and events to Logisy's.
\n","event":[{"listen":"prerequest","script":{"id":"5aeedfd6-993f-42f2-932d-72db2433dc67","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7297306d-66ad-4fb1-82b1-178a27e45280","type":"text/javascript","exec":[""]}}],"_postman_id":"5917cd96-c793-4096-bdc4-700f3d809a6d"},{"name":"Client-side APIs / Webhooks","item":[{"name":"Historical Orders API","id":"106597de-503b-4fcf-98ed-81459bce074a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Token","type":"text","value":"{{API_KEY}}"}],"url":"https://your-store.com/your-historical-orders-api-url?page=1&from=2020-09-12T14:20:34+05:30&to=2021-01-12T14:20:34+05:30","description":"This API is required so that Logisy can pull historical order data from your servers.
\nISO 8601 datetime str): The timestamp from which the data needs to be providedISO 8601 datetime str): The timestamp till which the data needs to be provided200 OKsince parameter valueorder obj): List of order objects with AWB information\n\n","urlObject":{"protocol":"https","path":["your-historical-orders-api-url"],"host":["your-store","com"],"query":[{"key":"page","value":"1"},{"key":"from","value":"2020-09-12T14:20:34+05:30"},{"key":"to","value":"2021-01-12T14:20:34+05:30"}],"variable":[]}},"response":[{"id":"8cd9a5f9-b6c2-4da1-b59b-eee7fe8fc300","name":"Historical Orders API","originalRequest":{"method":"GET","header":[{"key":"X-API-Token","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"https://your-store.com/your-historical-orders-api-url?page=1&since=2020-09-12T14:20:34+05:30","protocol":"https","host":["your-store","com"],"path":["your-historical-orders-api-url"],"query":[{"key":"page","value":"1"},{"key":"since","value":"2020-09-12T14:20:34+05:30"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_orders\": 8731,\n \"orders\": [\n {\n \"id\": 2711891284034,\n \"note\": \"Some note about this order\",\n \"tags\": \"some_tag_1,some_tag_2\",\n \"...\": \"...\"\n }\n ]\n}"}],"_postman_id":"106597de-503b-4fcf-98ed-81459bce074a"},{"name":"Order API","id":"e5acb0a8-3254-454f-be30-ba6e59b53a17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":"https://your-store.com/your-order-api-url?id=2711891284034","description":"NOTE: Please make sure that the values for the following fields are present in order to sync the end-states of the orders:
\nshipment_tracking_id,shipment_company,shipment_tracking_url,is_delivered,is_rto,cancelled_at
This API is required so that Logisy can pull order data for one particular order from your servers.
\norder to be fetched200 OKorder obj): The order which was queriedLogisy will send a request upon successful completion of C2P (COD-to-Paid) process for an order. Logisy will expect an order id in return. This order id can be one of the following
\n\nNOTE: We recommend you create a new order and cancel the original COD order. This way any other system listening to your store may automatically take the necessary actions (e.g.: Your shipment company will cancel the COD order's shipment while creating a new one for the new paid order.)
\n
The order id in the result is then mapped by Logisy with the original COD order
\nfixed or percent200 OKpaid by your system after successful C2P200 OK will be considered as an error and Logisy will make three further attempts to post the dataLogisy might trigger a cancel order request due to the following reasons
\n\n\nNOTE: Any change in the order data must trigger the Update/Cancel Order Webhook from your side. Thus, these actions (e.g.: tags added or order cancelled) will be reflected in Logisy's dashboard only if it receives the order update via the webhook/s.
\n
200 OK200 OK will be considered as an error and Logisy will make three further attempts to post the dataDuring the lifecycle of an order, various events may happen. Logisy will publish these events' data via this webhook. The events are described in the Payload section below. Please note that apart from the order_id, all the other parameters are optional (as they get generated at different events). However, at least one of the mentioned events is guaranteed to be present.
\n\nNOTE: Any change in the order data must trigger the Update Order Webhook from your side. Thus, these actions (e.g.: tags added or removed) will be reflected in Logisy's dashboard only if it receives the order update via the webhook.
\n
200 OK200 OK will be considered as an error and Logisy will make three further attempts to post the dataLogisy will push an order's flags and analysis via this webhook. This is not a mandatory webhook and you may choose to implement this only if you require the analysis in your system. You can access all the analysis in Logisy dashboard itself.
\norder for which flags were generated200 OK200 OK will be considered as an error and Logisy will make three further attempts to post the dataThe following list of APIs/webhooks needs to be implemented at the store's system so that order data can be queried or posted by Logisy as and when needed.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"67b37fe6-7da2-40aa-80a5-90cf2ee1d8c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3d251495-a6d5-416e-82b4-ab717311952a","type":"text/javascript","exec":[""]}}],"_postman_id":"13c7bdd2-db05-4617-9ec9-405668c9025d"}],"id":"b360ac21-cef8-4419-b8f5-be91a70ce5b2","description":"NOTE: All the following APIs/webhooks expect
\n200 OKas HTTP statuses. Anything else is consdered as an error and thus Logisy will re-try the webhooks for a maximum of three times with a gap of 1 min between each successive try. If your APIs still fail, Logisy will let you know via an email.
Orders are created when a customer makes a successful purchase from your store. There are many events that happen during an order's lifecycle. Please refer to the diagram below for better understanding.
\n![](\"https://logisy.s3.amazonaws.com/documentation_images/OrderEvents.jpg\")
The following is the structure of the Order Object.
\nISO 8601 datetime str): Order creation timestampline_items arr): The details about the items being purchased via this order. Check the line_items array below for referenceaddress obj): Check the address object below for referencepending and for pre-paid order, send paidISO 8601 datetime str, optional): If the order has already been cancelled, provide the cancelled at timestampaddress obj): Check the address object below for referencecash_on_delivery for COD orders{\n \"id\": \"2711891284034\",\n \"note\": \"Some note about this order\",\n \"tags\": \"some_tag_1,some_tag_2\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"janedoe@somesite.com\",\n \"phone\": \"9880000000\",\n \"currency\": \"INR\",\n \"shipping_cost\": \"100.00\",\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"created_at\": \"2020-09-12T14:20:34+05:30\",\n \"line_items\": [\n {\n \"id\": \"2349854027448\",\n \"sku\": \"7JHD8893 BLUE STRIPE TEE SHIRT 04 M\",\n \"name\": \"Stripe Tee Shirt - M / Blue\",\n \"title\": \"Stripe Tee Shirt\",\n \"grams\": 1200,\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"quantity\": 2,\n \"product_id\": \"5684027447458\",\n \"variant_id\": \"36047249860194\"\n },\n {\n \"id\": \"2349854027501\",\n \"sku\": \"7JHD8893 GREEN STRIPE TEE SHIRT 04 M\",\n \"name\": \"Stripe Tee Shirt - M / Green\",\n \"title\": \"Stripe Tee Shirt\",\n \"grams\": 1300,\n \"total_tax\": \"99.00\",\n \"total_discounts\": \"0.00\",\n \"price_without_tax\": \"1000.00\",\n \"total_price\": \"1099.00\",\n \"quantity\": 1,\n \"product_id\": \"5684027447458\",\n \"variant_id\": \"36047249860194\"\n }\n ],\n \"checkout_id\": \"14689190521954\",\n \"source_name\": \"web\",\n \"order_number\": \"12926\",\n \"discount_codes\": [\n \"DIWALI123\",\n \"FLAT100OFF\"\n ],\n \"billing_address\": {\n \"id\": \"4824720729506\",\n \"zip\": \"110000\",\n \"city\": \"New Delhi\",\n \"phone\": \"+919880000000\",\n \"country\": \"India\",\n \"default\": true,\n \"address1\": \"Address line 1\",\n \"address2\": \"Address line 2\",\n \"province\": \"Delhi\",\n \"country_code\": \"IN\",\n \"country_name\": \"India\",\n \"province_code\": \"DL\",\n \"latitude\": 76.99874,\n \"longitude\": 78.773522\n },\n \"financial_status\": \"pending\",\n \"shipment_tracking_id\": \"77495628340\",\n \"shipment_company\": \"Delhivery\",\n \"shipment_tracking_url\": \"https://delhivery.com/track/77495628340/\",\n \"is_delivered\": false,\n \"is_rto\": false,\n \"cancelled_at\": null,\n \"order_status_url\": \"https://yourstore.com/orders/2711891284034/\",\n \"shipping_address\": {\n \"id\": \"4824720729506\",\n \"zip\": \"110000\",\n \"city\": \"New Delhi\",\n \"phone\": \"+919880000000\",\n \"country\": \"India\",\n \"default\": true,\n \"address1\": \"Address line 1\",\n \"address2\": \"Address line 2\",\n \"province\": \"Delhi\",\n \"country_code\": \"IN\",\n \"country_name\": \"India\",\n \"province_code\": \"DL\",\n \"latitude\": 76.99874,\n \"longitude\": 78.773522\n },\n \"payment_gateway_names\": [\n \"cash_on_delivery\",\n \"cashfree\"\n ],\n \"buyer_accepts_marketing\": true,\n \"device_id\": \"uisd67834iuiu5489\",\n \"referring_site\": \"https://facebook.com/some-campaign/\",\n \"browser_ip\": \"192.168.0.145\",\n \"brand_name: \"Brand X\"\n}\n\npercent, it will be treated as a percentage value, else as the absolute value. E.g.: {\"value\": 50.00, \"type\": \"fixed\"} means INR 50.00 off, whereas, {\"value\": 7.5, \"type\": \"percent\"} means 7.5% off200 OKThe following list of APIs/webhooks need to be provided by your system so that your Logisy can request for coupons.
\n","event":[{"listen":"prerequest","script":{"id":"e3e0b1f5-2644-4b62-b4ff-1b20b55e1095","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"970cf4b8-5472-4404-bf82-d4c41de9d963","type":"text/javascript","exec":[""]}}],"_postman_id":"d4459f9c-f718-4a25-a690-965c8ec0c0b9"}],"id":"e8614c4d-dc34-40ab-a477-d76c185bd1c7","description":"In order to maximize conversion, Logisy sends offers to potential customers. Thus a coupon generation API is required for the same.
\n","event":[{"listen":"prerequest","script":{"id":"21dd5ebf-dd5a-4444-935e-7d5ba14d079a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9cfe3c64-4d85-4c02-b762-a634fa447ad5","type":"text/javascript","exec":[""]}}],"_postman_id":"e8614c4d-dc34-40ab-a477-d76c185bd1c7"},{"name":"Products","item":[{"name":"Pragma APIs / Webhooks","item":[{"name":"Product List API","id":"4a7f151b-8d52-4d3c-b7da-f5a597949225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":"{{HOST}}/api/stores/products/?limit=10&offset=0","urlObject":{"path":["api","stores","products",""],"host":["{{HOST}}"],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"007829f2-f8d8-4257-9879-0362783170f2","name":"Product List","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":{"raw":"{{HOST}}/api/stores/products/?limit=10&offset=0","host":["{{HOST}}"],"path":["api","stores","products",""],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1051457,\n \"handle\": \"amazing-shoes2\",\n \"product_url\": \"https:///products/amazing-shoes2\",\n \"product_title\": \"Amazing Shoes2\",\n \"store_product_id\": \"2\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1406210246,\n \"variant_img\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"variant_id\": \"2\",\n \"sku\": \"46748JFGH7\",\n \"price\": \"1200.00\",\n \"title\": \"S\",\n \"inventory_quantity\": 51,\n \"product_id\": 1051457,\n \"inventory_management\": null\n }\n ],\n \"images\": []\n },\n {\n \"id\": 1051754,\n \"handle\": \"None\",\n \"product_url\": \"None\",\n \"product_title\": \"VVVVVVVVVVVV-Small\",\n \"store_product_id\": \"2761\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1413683934,\n \"variant_img\": null,\n \"variant_id\": \"3256\",\n \"sku\": \"VVVVVVVVVVVV-Large\",\n \"price\": \"300.00\",\n \"title\": \"VVVVVVVVVVVV-Large\",\n \"inventory_quantity\": 1,\n \"product_id\": 1051754,\n \"inventory_management\": null\n },\n {\n \"id\": 1413683922,\n \"variant_img\": null,\n \"variant_id\": \"3255\",\n \"sku\": \"VVVVVVVVVVVV-Small\",\n \"price\": \"200.00\",\n \"title\": \"VVVVVVVVVVVV-Small\",\n \"inventory_quantity\": 1,\n \"product_id\": 1051754,\n \"inventory_management\": null\n }\n ],\n \"images\": [\n {\n \"id\": 467375234,\n \"image_id\": \"1051754_3256\",\n \"src\": \"\",\n \"product_id\": 1051754,\n \"variant_ids\": [\n \"3256\"\n ]\n }\n ]\n },\n {\n \"id\": 1051856,\n \"handle\": \"None\",\n \"product_url\": \"None\",\n \"product_title\": \"Levis Tshirt-Small\",\n \"store_product_id\": \"2762\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1414076611,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/images/image_1733466681.png\",\n \"variant_id\": \"3257\",\n \"sku\": \"Levis Tshirt-Small\",\n \"price\": \"1600.00\",\n \"title\": \"Levis Tshirt-Small\",\n \"inventory_quantity\": 1,\n \"product_id\": 1051856,\n \"inventory_management\": null\n },\n {\n \"id\": 1414076612,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/images/image_1733466681.png\",\n \"variant_id\": \"3258\",\n \"sku\": \"Levis Tshirt-Large\",\n \"price\": \"1600.00\",\n \"title\": \"Levis Tshirt-Large\",\n \"inventory_quantity\": 1,\n \"product_id\": 1051856,\n \"inventory_management\": null\n }\n ],\n \"images\": []\n },\n {\n \"id\": 1051769,\n \"handle\": \"amazing-shoes3\",\n \"product_url\": \"None\",\n \"product_title\": \"Amazing Shoes3\",\n \"store_product_id\": \"3\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1413808538,\n \"variant_img\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"variant_id\": \"3\",\n \"sku\": \"46748JFGH7\",\n \"price\": \"1200.00\",\n \"title\": \"S\",\n \"inventory_quantity\": 51,\n \"product_id\": 1051769,\n \"inventory_management\": null\n }\n ],\n \"images\": []\n },\n {\n \"id\": 1051980,\n \"handle\": \"colorbar-amino-skin-radiant-foundation-dabe9a\",\n \"product_url\": \"None\",\n \"product_title\": \"Colorbar Amino Skin Radiant Foundation #DABE9A\",\n \"store_product_id\": \"301\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1415297761,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/CBASRF-Ivory Fair-1.jpg\",\n \"variant_id\": \"9\",\n \"sku\": \"COLORBAR AMINO SKIN RADIANT FOUNDATION-15-IVORY FAIR\",\n \"price\": \"1039.00\",\n \"title\": \"Colorbar Amino Skin Radiant Foundation - IVORY FAIR - (15 GRAM)\",\n \"inventory_quantity\": 19,\n \"product_id\": 1051980,\n \"inventory_management\": null\n },\n {\n \"id\": 1415297762,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/CBASRF-Petal Fair-1.jpg\",\n \"variant_id\": \"10\",\n \"sku\": \"COLORBAR AMINO SKIN RADIANT FOUNDATION-15-PETAL FAIR\",\n \"price\": \"1039.00\",\n \"title\": \"Colorbar Amino Skin Radiant Foundation - PETAL FAIR - (15 GRAM)\",\n \"inventory_quantity\": 20,\n \"product_id\": 1051980,\n \"inventory_management\": null\n },\n {\n \"id\": 1415297763,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/CBASRF-Beige Mild-1.jpg\",\n \"variant_id\": \"11\",\n \"sku\": \"COLORBAR AMINO SKIN RADIANT FOUNDATION-15-BEIGE MILD\",\n \"price\": \"1039.00\",\n \"title\": \"Colorbar Amino Skin Radiant Foundation - BEIGE MILD - (15 GRAM)\",\n \"inventory_quantity\": 20,\n \"product_id\": 1051980,\n \"inventory_management\": null\n },\n {\n \"id\": 1415297764,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/CBASRF-Rose Mild-1.jpg\",\n \"variant_id\": \"12\",\n \"sku\": \"COLORBAR AMINO SKIN RADIANT FOUNDATION-15-ROSE MILD\",\n \"price\": \"1039.00\",\n \"title\": \"Colorbar Amino Skin Radiant Foundation - ROSE MILD - (15 GRAM)\",\n \"inventory_quantity\": 20,\n \"product_id\": 1051980,\n \"inventory_management\": null\n },\n {\n \"id\": 1415297765,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/CBASRF-Sand Medium-1.jpg\",\n \"variant_id\": \"13\",\n \"sku\": \"COLORBAR AMINO SKIN RADIANT FOUNDATION-15-SAND MEDIUM\",\n \"price\": \"1039.00\",\n \"title\": \"Colorbar Amino Skin Radiant Foundation - SAND MEDIUM - (15 GRAM)\",\n \"inventory_quantity\": 20,\n \"product_id\": 1051980,\n \"inventory_management\": null\n }\n ],\n \"images\": []\n },\n {\n \"id\": 1051983,\n \"handle\": \"fogg-eau-de-perfume-sultan\",\n \"product_url\": \"None\",\n \"product_title\": \"Fogg Eau De Perfume - Sultan\",\n \"store_product_id\": \"308\",\n \"description\": \"\",\n \"product_type\": \"\",\n \"variants\": [\n {\n \"id\": 1415313933,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/FG SULTAN EDP15-1.webp\",\n \"variant_id\": \"27\",\n \"sku\": \"FOGG EAU DE PERFUME - SULTAN-15\",\n \"price\": \"89.00\",\n \"title\": \"Fogg Eau De Perfume - Sultan - - (15 ML)\",\n \"inventory_quantity\": 10,\n \"product_id\": 1051983,\n \"inventory_management\": null\n },\n {\n \"id\": 1415313934,\n \"variant_img\": \"https://womancart-laravel-1.s3.ap-south-1.amazonaws.com/public/Product/FG SULTAN EDP15-1.webp\",\n \"variant_id\": \"28\",\n \"sku\": \"FOGG EAU DE PERFUME - SULTAN-30\",\n \"price\": \"145.00\",\n \"title\": \"Fogg Eau De Perfume - Sultan - - (30 ML)\",\n \"inventory_quantity\": 10,\n \"product_id\": 1051983,\n \"inventory_management\": null\n }\n ],\n \"images\": []\n }\n ],\n \"success\": true,\n \"error\": null\n}"}],"_postman_id":"4a7f151b-8d52-4d3c-b7da-f5a597949225"},{"name":"Product Details API","id":"3efa867c-825d-429d-bdd1-d5f44de79e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":"{{HOST}}/api/stores/products/{{product_id}}/","urlObject":{"path":["api","stores","products","{{product_id}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"e1c5fae7-d321-4400-9963-67de8067215f","name":"Get Product API Response","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"url":"{{HOST}}/api/stores/products/{{product_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Security-Policy","value":"default-src * data: 'unsafe-eval' 'unsafe-inline'"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 05 Dec 2024 07:15:24 GMT"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":"Caddy"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1050449,\n \"product_id\": \"1\",\n \"title\": \"Colorbar Pro Eyelashes You Complete Me 1 Pair\",\n \"handle\": \"colorbar-pro-eyelashes-you-complete-me-1-pair\",\n \"status\": \"active\",\n \"description\": \"\",\n \"tags\": \"\",\n \"updated_at\": null,\n \"images\": [],\n \"variants\": [\n {\n \"variant_id\": \"1\",\n \"sku\": \"MAYBELLINE NEW YORK FASHION BROW CREAM PENCIL--DARK BROWN\"\n },\n {\n \"variant_id\": \"2\",\n \"sku\": \"MAYBELLINE NEW YORK FASHION BROW CREAM PENCIL--BROWN\"\n }\n ],\n \"product_url\": \"https://priyankbadjatiya.com/products/1050449\"\n }\n ],\n \"success\": true,\n \"error\": null\n}"}],"_postman_id":"3efa867c-825d-429d-bdd1-d5f44de79e3e"},{"name":"Create Product API","id":"18209067-d938-413a-97a7-27d786c21b07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"{{API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"2711891284034\",\n \"title\": \"Amazing Shoes\",\n \"handle\": \"amazing-shoes\",\n \"product_type\": \"\",\n \"collection_id\": \"\",\n \"created_at\": \"\",\n \"published_at\": \"\",\n \"tags\": \"\",\n \"status\": \"active\", // \"active\" or \"draft\"\n \"variants\": [\n {\n \"id\": \"37295239528612\",\n \"sku\": \"LKSDJKJDS-1\",\n \"grams\": 1200,\n \"price\": \"1200.00\",\n \"title\": \"S\",\n \"weight\": 1.2,\n \"taxable\": true,\n \"created_at\": \"2020-12-23T00:13:35-05:00\",\n \"product_id\": \"5941074034852\",\n \"updated_at\": \"2021-03-10T04:00:02-05:00\",\n \"weight_unit\": \"kg\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"value\": \"M\"\n },\n {\n \"name\": \"Color\",\n \"value\": \"Black\"\n },\n {\n \"name\": \"Anything\",\n \"value\": \"Something\"\n }\n ],\n \"inventory_quantity\": 51,\n \"images\": [\n {\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n }\n ]\n },\n {\n \"id\": \"37295239561380\",\n \"sku\": \"LKSDJKJDS-2\",\n \"grams\": 1200,\n \"price\": \"1200.00\",\n \"title\": \"M\",\n \"weight\": 1.2,\n \"taxable\": true,\n \"created_at\": \"2020-12-23T00:13:35-05:00\",\n \"product_id\": \"5941074034852\",\n \"updated_at\": \"2021-03-05T02:46:37-05:00\",\n \"weight_unit\": \"kg\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"value\": \"M\"\n },\n {\n \"name\": \"Color\",\n \"value\": \"Black\"\n },\n {\n \"name\": \"Anything\",\n \"value\": \"Something\"\n }\n ],\n \"inventory_quantity\": 32,\n \"images\": [\n {\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/api/stores/products/create/","description":"Create a product Object in Logisy by calling the following API.
product obj): The product object (see above for reference)Update a product Object in Logisy by calling the following API based on order id.
\n\nNOTE: The only mandatory parameter is the product's
\nid. You can send only the parameters which have updates.
product obj): The product object to be updated (see above for reference)Marks a product Object as deleted.
product which got deletedFor updating the product inventory when ever a item is sold online or inventory stock is updated.
\nThe following list of APIs/webhooks are provided by Logisy so that your system can push product related data and events to Logisy's.
\n","event":[{"listen":"prerequest","script":{"id":"16fb88ca-86cb-48a1-be13-0b23ecb67d13","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96e95fca-48da-44bf-be9b-7f051511eb15","type":"text/javascript","exec":[""]}}],"_postman_id":"76872491-966d-4b13-921a-c0fe838efb84"},{"name":"Client-side APIs / Webhooks","item":[{"name":"All Products API","id":"5f33e23d-c85e-4474-ab6f-5228d66f6cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Token","value":"{{API_KEY}}","type":"text"}],"url":"https://your-store.com/your-all-products-api-url?page=1&page_size=100&since=2020-09-12T14:20:34+05:30","description":"This webhook is required so that Logisy can pull all order data from your servers.
\n200 OKsince parameter valueproduct obj): List of product objectsThis webhook is required so that Logisy can fetch a product's images from your servers.
\n200 OKimage obj): List of image objectsThe following list of APIs/webhooks needs to be implemented at the store's system so that product data can be queried or posted by Logisy as and when needed.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"dcdf0aef-1741-4d11-a870-b7343487d5d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1772bf1b-ec21-4ac8-931e-64dcc5705573","type":"text/javascript","exec":[""]}}],"_postman_id":"216e2540-dd0f-4156-9ecc-dc5bb14b6aa6"}],"id":"85d5c6a6-3e83-4988-baf4-6f76df73b0e7","description":"NOTE: All the following APIs/webhooks expect
\n200 OKas HTTP statuses. Anything else is consdered as an error and thus Logisy will re-try the webhooks for a maximum of three times with a gap of 1 min between each successive try. If your APIs still fail, Logisy will let you know via an email.
Products are the items that are sold to a customer via the line_items parameter present in an Abandoned Checkout or an Order.
id (str): A unique id assigned by your store's system
\ntitle (str): The title of the product
\nhandle (str): The url handle of the product
\nproduct_type (str):
\ncollection_id (str):
\ncreated_at (str):
\npublished_at (str):
\ntags (str): Tags associated with the product
\nvariants (arr of variant obj): An array of variant objects (see below)
{\n \"id\": \"2711891284034\",\n \"title\": \"Amazing Shoes\",\n \"handle\": \"amazing-shoes\",\n \"product_type\": \"\",\n \"collection_id\": \"\",\n \"created_at\": \"\",\n \"published_at\": \"\",\n \"tags\": \"\",\n \"variants\": [\n {\n \"id\": \"37295239528612\",\n \"sku\": \"LKSDJKJDS-1\",\n \"grams\": 1200,\n \"price\": \"1200.00\",\n \"title\": \"S\",\n \"weight\": 1.2,\n \"taxable\": true,\n \"created_at\": \"2020-12-23T00:13:35-05:00\",\n \"product_id\": \"5941074034852\",\n \"updated_at\": \"2021-03-10T04:00:02-05:00\",\n \"weight_unit\": \"kg\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"value\": \"M\"\n },\n {\n \"name\": \"Color\",\n \"value\": \"Black\"\n },\n {\n \"name\": \"Anything\",\n \"value\": \"Something\"\n }\n ],\n \"inventory_quantity\": 51,\n \"images\": [\n {\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n }\n ]\n },\n {\n \"id\": \"37295239561380\",\n \"sku\": \"LKSDJKJDS-2\",\n \"grams\": 1200,\n \"price\": \"1200.00\",\n \"title\": \"M\",\n \"weight\": 1.2,\n \"taxable\": true,\n \"created_at\": \"2020-12-23T00:13:35-05:00\",\n \"product_id\": \"5941074034852\",\n \"updated_at\": \"2021-03-05T02:46:37-05:00\",\n \"weight_unit\": \"kg\",\n \"options\": [\n {\n \"name\": \"Size\",\n \"value\": \"M\"\n },\n {\n \"name\": \"Color\",\n \"value\": \"Black\"\n },\n {\n \"name\": \"Anything\",\n \"value\": \"Something\"\n }\n ],\n \"inventory_quantity\": 32,\n \"images\": [\n {\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n }\n ]\n }\n ]\n}\n\nVariants of a product have the following structure.
image obj): An array of image objects (see below){\n \"id\": \"37295239528612\",\n \"title\": \"S\",\n \"sku\": \"LKSDJKJDS-1\",\n \"grams\": 1200,\n \"price\": \"1200.00\",\n \"weight\": 1.2,\n \"taxable\": true,\n \"created_at\": \"2020-12-23T00:13:35-05:00\",\n \"product_id\": \"5941074034852\",\n \"updated_at\": \"2021-03-10T04:00:02-05:00\",\n \"weight_unit\": \"kg\",\n \"inventory_quantity\": 51,\n \"images\": [\n {\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n }\n ]\n}\nImages belonging to a product or a variant.
{\n \"src\": \"https://cdn.shopify.com/s/files/1/0519/3390/5060/products/Stefano-Bemer-Shoes-1-1027x560.jpg?v=1608700417\",\n \"width\": 1027,\n \"height\": 560\n}\nAdjust stock method is used to manage the inventory of a particular product variant. A post request will be made to your url endpoint with the product details and adjustments.
\nAdjust stock works in the following way: -
\nParameters
\nCalculate the refund of an order based on line items and shipping.
\n","urlObject":{"protocol":"https","path":["orders","You can use webhook subscriptions to receive notifications about particular events. It will help you to get the status of the request instantly instead of having to make API calls periodically to check their status. After you've subscribed to a webhook event, you will receive the notification at your desired endpoint.
\n{\n \"event\": \"exchange_initaited\",\n \"id\": 678,\n \"reference_id\": \"6081EXC1865\",\n \"order_id\": \"5041045504153\",\n \"order_number\": \"1865\",\n \"customer_first_name\": \"Debopriyo\",\n \"customer_last_name\": \"Das\",\n \"customer_email\": \"debopriyo@logisy.tech\",\n \"customer_phone_number\": \"+916001261818\",\n \"return_type\": \"exchange\",\n \"customer_reason_code\": null,\n \"customer_reason_label\": null,\n \"created_at\": \"2023-08-19T09:17:44.371762+05:30\",\n \"status\": 101,\n \"priority\": null,\n \"tags\": null,\n \"customer_address_line_1\": \"Mestri Palya\",\n \"customer_address_line_2\": \"Vasathi Avante Apt.\",\n \"customer_address_city\": \"Bangalore\",\n \"customer_address_state\": \"Karnataka\",\n \"qc_performed_at\": null,\n \"customer_address_pin\": \"560045\",\n \"customer_address_country\": \"India\",\n \"customer_preferred_refund_method\": null,\n \"is_deleted\": false,\n \"closed\": false,\n \"closed_at\": null,\n \"closing_notes\": null,\n \"reject_reason\": null,\n \"bank_transfer_charge\": \"0.00\",\n \"coupon_charge\": \"0.00\",\n \"exchange_shipment_charge\": \"0.00\",\n \"return_shipment_charge\": \"50.00\",\n \"reimburse_amount\": \"0.00\",\n \"amount_to_refund_after_exchange\": \"50.00\",\n \"product_tag_exists\": false,\n \"shipment_handled_by\": null,\n \"pre_approve_refund_amount\": null,\n \"picked_up_created_at\": null,\n \"line_items\": [\n {\n \"variant_id\": \"43222030647449\",\n \"product_title\": \"\\\"rainbow\\\" half sleeve rayon shirt\",\n \"variant_name\": \"S\",\n \"product_sku\": \"\",\n \"product_price\": \"622.12\",\n \"variant_image_url\": \"https://cdn.shopify.com/s/files/1/0613/4559/5545/files/GSHSSHT20246RANBOW_4.jpg?v=1687355013\",\n \"variant_weight\": \"500.00\",\n \"variant_weight_unit\": \"g\",\n \"quantity\": 1,\n \"exchange_product_id\": \"7680752418969\",\n \"exchange_product_title\": \"\\\"rainbow\\\" half sleeve rayon shirt\",\n \"exchange_variant_id\": \"43222030680217\",\n \"exchange_variant_name\": \"M\",\n \"exchange_product_sku\": \"\",\n \"exchange_product_price\": \"779.00\",\n \"exchange_variant_image_url\": \"https://cdn.shopify.com/s/files/1/0613/4559/5545/files/GSHSSHT20246RANBOW_4.jpg?v=1687355013\",\n \"exchange_variant_weight\": \"500.00\",\n \"exchange_variant_weight_unit\": \"g\",\n \"return_type\": \"exchange\",\n \"id\": 924,\n \"accepted\": true,\n \"generate_reverse\": true,\n \"rejected\": false,\n \"product_id\": \"7680752418969\",\n \"return_warehouse_id\": \"30167\",\n \"warehouse_confirmed\": false,\n \"return_address_id\": null,\n \"return_order_number\": null,\n \"return_manifest_number\": null,\n \"return_shipment_id\": null,\n \"return_shipment_awb\": null,\n \"return_shipment_method\": null,\n \"return_shipment_company\": null,\n \"return_shipment_url\": null,\n \"return_shipment_status\": null,\n \"picked_up_created_at\": null,\n \"qc_passed\": false,\n \"qc_performed_at\": null,\n \"customer_reason_label\": \"Poor quality\",\n \"customer_sub_reason_label\": null,\n \"picked_up\": false,\n \"delivered\": false,\n \"uniware_reverse_pickup_code\": null\n },\n {\n \"variant_id\": \"43222006268057\",\n \"product_title\": \"\\\"bear\\\" full sleeve black fleece hoodie-gsfshdbeer3017blk\",\n \"variant_name\": \"S\",\n \"product_sku\": \"GSFSHDBEER3017BLK_S\",\n \"product_price\": \"717.96\",\n \"variant_image_url\": \"https://cdn.shopify.com/s/files/1/0613/4559/5545/files/GSFSHDBEER3017BLK_3.jpg?v=1687354676\",\n \"variant_weight\": \"500.00\",\n \"variant_weight_unit\": \"g\",\n \"quantity\": 3,\n \"exchange_product_id\": \"7680751730841\",\n \"exchange_product_title\": \"\\\"bear\\\" full sleeve black fleece hoodie-gsfshdbeer3017blk\",\n \"exchange_variant_id\": \"43222006300825\",\n \"exchange_variant_name\": \"M\",\n \"exchange_product_sku\": \"GSFSHDBEER3017BLK_M\",\n \"exchange_product_price\": \"899.00\",\n \"exchange_variant_image_url\": \"https://cdn.shopify.com/s/files/1/0613/4559/5545/files/GSFSHDBEER3017BLK_3.jpg?v=1687354676\",\n \"exchange_variant_weight\": \"500.00\",\n \"exchange_variant_weight_unit\": \"g\",\n \"return_type\": \"exchange\",\n \"id\": 923,\n \"accepted\": true,\n \"generate_reverse\": true,\n \"rejected\": false,\n \"product_id\": \"7680751730841\",\n \"return_warehouse_id\": \"30167\",\n \"warehouse_confirmed\": false,\n \"return_address_id\": null,\n \"return_order_number\": null,\n \"return_manifest_number\": null,\n \"return_shipment_id\": null,\n \"return_shipment_awb\": null,\n \"return_shipment_method\": null,\n \"return_shipment_company\": null,\n \"return_shipment_url\": null,\n \"return_shipment_status\": null,\n \"picked_up_created_at\": null,\n \"qc_passed\": false,\n \"qc_performed_at\": null,\n \"customer_reason_label\": \"Poor quality\",\n \"customer_sub_reason_label\": null,\n \"picked_up\": false,\n \"delivered\": false,\n \"uniware_reverse_pickup_code\": null\n }\n ],\n \"exchange_details\": [\n {\n \"exchange_order_number\": \"1958\",\n \"exchange_order_id\": \"5068294324377\",\n \"exchange_status\": \"exchange_initiated\",\n \"exchange_order_financial_status\": \"partially_paid\",\n \"exchange_order_url\": \"https://bepragma-demo.myshopify.com/61345595545/orders/36e507d8e6c89b30b8753f4cee275417/authenticate?key=0e04da1b49702c9b0988b02d41434c58\",\n \"exchange_initiated_by\": \"lgsy_bot\",\n \"exchange_initiated_at\": \"2023-08-19 03:47:45\",\n \"exchange_on_hold\": \"Yes\",\n \"return_request\": \"6081EXC1865\"\n },\n {\n \"exchange_order_number\": \"1959\",\n \"exchange_order_id\": \"5068294389913\",\n \"exchange_status\": \"exchange_initiated\",\n \"exchange_order_financial_status\": \"partially_paid\",\n \"exchange_order_url\": \"https://bepragma-demo.myshopify.com/61345595545/orders/88aee435f70b87530b41dfc7da1a7e90/authenticate?key=79b6f5d73ca0fbc9ffa240da85b06917\",\n \"exchange_initiated_by\": \"lgsy_bot\",\n \"exchange_initiated_at\": \"2023-08-19 03:47:47\",\n \"exchange_on_hold\": \"Yes\",\n \"return_request\": \"6081EXC1865\"\n }\n ],\n \"refund_details\": [\n {\n \"refund_type\": \"reimbursement\",\n \"customer_preferred_refund_method\": null,\n \"refund_method\": \"coupon\",\n \"account_number\": null,\n \"confirm_account_number\": null,\n \"account_holder_name\": null,\n \"ifsc_code\": null,\n \"vpa\": null,\n \"refund_amount\": \"50.00\",\n \"giftcard_code\": null,\n \"giftcard_expires_on\": null,\n \"giftcard_id\": null,\n \"refund_status\": \"refund_completed\",\n \"cashgram_status\": null,\n \"razorpayx_status\": null,\n \"bank_transfer_status\": null,\n \"refund_id\": \"63F8D3\",\n \"payout_idempotency_key\": null,\n \"refund_url\": null,\n \"refund_url_expiry\": null,\n \"refund_note\": null,\n \"refund_initiated_by\": \"bepragmademo@gmail.com\",\n \"refund_initiated_at\": \"2023-08-21 09:10:47\",\n \"refund_bypassed\": null,\n \"new_link_generated\": false,\n \"return_request\": \"6081EXC1865\"\n }\n ],\n \"reverse_shipments\": [],\n \"comments\": [],\n \"self_ship_details\": null\n}\n\nThis document outlines the REST APIs that a merchant-managed wallet service must expose so that it can be plugged into the OneCheckout platform alongside the existing Nector integration. The contract is intentionally prescriptive—merchants are expected to implement the endpoints exactly as described below.
\nX-API-Key header whose value matches the secret shared by the wallet provider during onboarding.401 Unauthorized.X-API-Key: <merchant_specific_api_key>\nContent-Type: application/json\nReturns the current wallet balance for a customer. This endpoint is invoked whenever the checkout UI is rendered or refreshed.
\nPOST/wallet/v1/credits/fetch{\n \"customer\": {\n \"phone_number\": \"+91XXXXXXXXXX\",\n \"email\": \"optional@email.com\"\n },\n \"context\": {\n \"checkout_reference\": \"<one_checkout_checkout_id>\",\n \"cart_value\": 3499.0,\n \"currency\": \"INR\"\n }\n}\n{\n \"meta\": {\"code\": 200},\n \"data\": {\n \"available_credits\": 1200.0,\n \"conversion_factor\": 1.0,\n \"max_redeem_ratio\": 1.0,\n \"currency\": \"INR\"\n }\n}\navailable_credits – Total credits currently held by the customer.conversion_factor – How many units of checkout currency one wallet credit represents.max_redeem_ratio – Decimal fraction (0–1) that caps redemptions (e.g. 0.5 ⇒ 50% of cart value). For MerchantCustomWallet the expected value is 1.0 unless negotiated otherwise.404 with meta.code = 404.400 with details in the errors array.Determines how many credits can be applied to the current cart and returns the exact discount that should be reflected in OneCheckout.
\nPOST/wallet/v1/credits/calculate{\n \"customer\": {\n \"phone_number\": \"+91XXXXXXXXXX\"\n },\n \"context\": {\n \"checkout_reference\": \"<one_checkout_checkout_id>\",\n \"cart_value\": 3499.0,\n \"currency\": \"INR\",\n \"items\": [\n {\n \"sku\": \"SKU-1\",\n \"title\": \"Product name\",\n \"unit_price\": 999.0,\n \"quantity\": 2\n }\n ]\n }\n}\n{\n \"meta\": {\"code\": 200},\n \"data\": {\n \"calculation_reference\": \"calc_123456789\",\n \"redeemable_credits\": 1200.0,\n \"conversion_factor\": 1.0,\n \"discount_amount\": 1200.0,\n \"currency\": \"INR\"\n }\n}\nmax_redeem_ratio shared during onboarding. For instance, if the ratio is 0.5, the returned discount_amount should never exceed 50% of cart_value.discount_amount = 0 and redeemable_credits = 0 but still issue a unique calculation_reference for auditing.Invoked after the order is successfully placed. The wallet service is expected to mark the credits as redeemed and return a final confirmation identifier.
\nPOST/wallet/v1/credits/redeem{\n \"calculation_reference\": \"calc_123456789\",\n \"checkout_reference\": \"<one_checkout_checkout_id>\",\n \"order_reference\": \"<platform_order_id>\",\n \"redeemed_credits\": 1200.0,\n \"discount_amount\": 1200.0,\n \"currency\": \"INR\",\n \"meta\": {\n \"payment_mode\": \"prepaid\",\n \"notes\": \"Optional reconciliation comment\"\n }\n}\n{\n \"meta\": {\"code\": 200},\n \"data\": {\n \"redemption_reference\": \"red_987654321\",\n \"status\": \"success\",\n \"processed_at\": \"2024-04-25T10:14:53Z\"\n }\n}\nmeta.code = 409 with a descriptive error message so OneCheckout can retry.meta.code = 404 or meta.code = 409 respectively.All failure responses should follow the same structure:
\n{\n \"meta\": {\"code\": <http_status_code>},\n \"errors\": [\n {\n \"code\": \"validation_error\",\n \"message\": \"Cart value cannot be negative\"\n }\n ]\n}\ncalculation_reference as idempotent within a checkout session.calculation_reference and checkout_reference combination must return the original response even if the operation has already been processed.X-Request-Id header in its response. OneCheckout will mirror this identifier in its logs to simplify debugging.available_credits, redeemable_credits, conversion_factor, and discount_amount should be serialised as JSON numbers. If null or malformed strings are returned we will treat the values as zero and suppress redemption for that checkout.cart_value is 0, return redeemable_credits = 0 and discount_amount = 0 but still generate a calculation_reference so the checkout can remain idempotent.400 and a descriptive error if the provided currency is unsupported—OneCheckout will surface the error to the merchant instead of attempting redemption.calculation_reference, respond with 409 and include the original redemption_reference. OneCheckout will persist that identifier without duplicating the redemption request.If a sandbox environment is offered, expose identical endpoints with a different API key. The payload and response structure must not differ between sandbox and production.
\nBy adhering to this specification, the external wallet can be seamlessly integrated into OneCheckout while remaining fully independent in terms of credit accrual and lifecycle management.
\n","_postman_id":"a11bba79-d149-4b6c-b1cd-8668a2946f36"},{"name":"ShipAxis","item":[{"name":"Pragma APIs / Webhooks","item":[{"name":"Couriers","item":[{"name":"Create Courier Priority For Warehouse API","id":"6d53e919-cc54-4dcc-99e6-4bd596489594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"priority_type\": \"forward\",\n \"priority\": 1,\n \"courier_display_name\": \"string\",\n \"courier_identifier\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/couriers/warehouse_courier_priority/:sa_warehouse_identifier/create","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","couriers","warehouse_courier_priority",":sa_warehouse_identifier","create"],"host":["https://api.example.com"],"query":[],"variable":[{"type":"any","value":"","key":"sa_warehouse_identifier"}]}},"response":[],"_postman_id":"6d53e919-cc54-4dcc-99e6-4bd596489594"},{"name":"Get Courier Priorities For Warehouse API","id":"b26b4e59-25b4-4f60-bf3b-159ac2726876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/couriers/warehouse_courier_priority/:sa_warehouse_identifier/list","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","couriers","warehouse_courier_priority",":sa_warehouse_identifier","list"],"host":["https://api.example.com"],"query":[],"variable":[{"type":"any","value":"","key":"sa_warehouse_identifier"}]}},"response":[],"_postman_id":"b26b4e59-25b4-4f60-bf3b-159ac2726876"}],"id":"24fce157-5764-41d9-b542-a33780251a10","_postman_id":"24fce157-5764-41d9-b542-a33780251a10","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}}},{"name":"Shipments","item":[{"name":"Create Forward Shipment API","id":"7c28ee26-0e94-4a26-80af-2a4a07684e5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\": \"string\",\n \"order_name\": \"string\",\n \"order_number\": \"string\",\n \"order_vendor\": \"string\",\n \"order_url\": \"http://example.com\",\n \"is_test_order\": false,\n \"payment_type\": \"cod\",\n \"subtotal_order_price\": 0,\n \"total_discounts\": 0,\n \"total_shipping_price\": 0,\n \"is_tax_included\": true,\n \"total_tax\": 0,\n \"total_order_price\": 0,\n \"total_paid\": 0,\n \"total_outstanding\": 0,\n \"package_weight\": \"500\",\n \"package_length\": \"10\",\n \"package_breadth\": \"10\",\n \"package_height\": \"10\",\n \"awb_number\": \"string\",\n \"tracking_url\": \"http://example.com\",\n \"logistics_provider\": \"bluedart\",\n \"logistics_provider_identifier\": \"string\",\n \"store_provider\": \"amazon\",\n \"billing_address\": {\n \"address_category\": \"commercial\",\n \"first_name\": \"Customer\",\n \"last_name\": \"string\",\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"landmark\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"pincode\": \"string\",\n \"country\": \"India\",\n \"country_code\": \"IN\",\n \"latitude\": \"string\",\n \"longitude\": \"string\",\n \"email\": \"user@example.com\",\n \"phone_number\": \"string\"\n },\n \"shipping_address\": {\n \"address_category\": \"commercial\",\n \"first_name\": \"Customer\",\n \"last_name\": \"string\",\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"landmark\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"pincode\": \"string\",\n \"country\": \"India\",\n \"country_code\": \"IN\",\n \"latitude\": \"string\",\n \"longitude\": \"string\",\n \"email\": \"user@example.com\",\n \"phone_number\": \"string\"\n },\n \"items\": [\n {\n \"line_item_id\": \"string\",\n \"product_id\": \"string\",\n \"product_title\": \"string\",\n \"variant_id\": \"string\",\n \"variant_name\": \"string\",\n \"sku\": \"string\",\n \"quantity\": 0,\n \"item_unit_price\": 0,\n \"item_total_discounts\": 0,\n \"is_tax_included\": true,\n \"item_total_tax\": 0,\n \"size\": \"string\",\n \"color\": \"string\",\n \"image\": \"http://example.com\",\n \"hsn_code\": \"string\",\n \"barcode\": \"string\",\n \"category\": \"string\",\n \"weight\": 0,\n \"length\": 0,\n \"breadth\": 0,\n \"height\": 0\n }\n ],\n \"pickup_warehouse_identifier\": \"string\",\n \"rto_warehouse_identifier\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/shipments/forward/create","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","shipments","forward","create"],"host":["https://api.example.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c28ee26-0e94-4a26-80af-2a4a07684e5b"},{"name":"Get Forward Shipment Details API","id":"a8a4f933-6f8d-42dc-a9c1-3fe179cfe925","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/shipments/forward/details?awb_number","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","shipments","forward","details"],"host":["https://api.example.com"],"query":[{"key":"awb_number","value":null}],"variable":[]}},"response":[],"_postman_id":"a8a4f933-6f8d-42dc-a9c1-3fe179cfe925"},{"name":"Get All Forward Shipments API","id":"8207bdba-d1b2-4ce6-b728-1bd7191d0a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/shipments/forward/list","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","shipments","forward","list"],"host":["https://api.example.com"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"order_id","value":"UHD123456"},{"disabled":true,"key":"query","value":""}],"variable":[]}},"response":[],"_postman_id":"8207bdba-d1b2-4ce6-b728-1bd7191d0a16"},{"name":"Cancel Forward Shipment API","id":"e9111fcb-ffbb-471c-a6c5-aa9e37a88902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"awb_number\": \"string\",\n \"cancel_shipment_order\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/shipments/forward/cancel","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","shipments","forward","cancel"],"host":["https://api.example.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9111fcb-ffbb-471c-a6c5-aa9e37a88902"},{"name":"Get Shipment Label API","id":"cdf684c0-2a85-4c71-969e-1297b2c3170f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/shipments/label?awb_number","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","shipments","label"],"host":["https://api.example.com"],"query":[{"key":"awb_number","value":null},{"disabled":true,"key":"dimensions","value":"5x5"},{"disabled":true,"key":"img_url","value":"https://logisy-connect.s3.amazonaws.com/MerchantUploadedMedia/597/6321_logothor1png.png"}],"variable":[]}},"response":[],"_postman_id":"cdf684c0-2a85-4c71-969e-1297b2c3170f"}],"id":"0bfee68d-6f2c-4598-8cd8-bd3a68c3c407","_postman_id":"0bfee68d-6f2c-4598-8cd8-bd3a68c3c407","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}}},{"name":"Warehouses","item":[{"name":"Create Warehouse API","id":"904f70ee-9c66-451e-9dc3-ba037f047efa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_active\": true,\n \"is_default\": false,\n \"title\": \"string\",\n \"address_line_1\": \"string\",\n \"address_line_2\": \"string\",\n \"landmark\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"pincode\": \"string\",\n \"country\": \"India\",\n \"country_code\": \"IN\",\n \"latitude\": \"string\",\n \"longitude\": \"string\",\n \"contact_first_name\": \"string\",\n \"contact_last_name\": \"string\",\n \"contact_email\": \"user@example.com\",\n \"contact_phone_number\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/warehouses/create","description":"The Create Warehouse API allows merchants to register a new warehouse/pickup location in the ShipAxis system. This warehouse can then be used as a pickup point for shipments.
\nHTTP Method: POST
Endpoint: /api/v1/warehouses/create
Status Code on Success: 201 Created
Authentication Required: Yes (Merchant API Key)
All parameters are sent in the request body as JSON.
\nUnique Warehouse Identification: The system automatically generates a unique sa_warehouse_identifier for every warehouse.
Default Warehouse Constraint: If is_default is set to true, the system enforces that only ONE default warehouse can exist per merchant. Attempting to create another default warehouse will result in a 409 Conflict error.
Duplicate Warehouse Detection: The system prevents duplicate warehouses creation
\nPhone Number Validation: The phone number must:
\nContain 9 to 15 digits
\nOptionally start with + or 1
Example valid formats: 9876543210, +919876543210, 19876543210
When a warehouse is successfully created, the API returns:
\n{\n \"success\": true,\n \"message\": \"Warehouse created successfully\",\n \"data\": {\n \"sa_warehouse_identifier\": \"unique_sa_warehouse_identifier\"\n },\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T09:23:13.123456+05:30\"\n}\n\nResponse Data Object Fields:
\n{\n \"success\": false,\n \"message\": \"Default Warehouse already exists\\nAssociated unique sa_warehouse_identifier: <sa_default_warehouse_identifier>\",\n \"error\": {\n \"detail\": \"<database_error_message>\"\n },\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T09:23:13.123456+05:30\"\n}\n\n{\n \"success\": false,\n \"message\": \"Warehouse titled 'Mumbai Main Warehouse' already exists for pincode 400069. Associated unique sa_warehouse_identifier: <sa_associated_warehouse_identifier>\",\n \"error\": {\n \"detail\": \"<database_error_message>\"\n },\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T09:23:13.123456+05:30\"\n}\n\nWhat to do with the response:
\nSave the sa_warehouse_identifier value from the response
Use this identifier in subsequent API calls to:
\nAdd warehouse sources (marketplace integrations)
\nCreate shipments with this warehouse as the pickup location
\nUpdate warehouse details
\nFetch warehouse information
\nSet is_default to true for the first warehouse you create. This warehouse will be used as the default pickup location when no specific warehouse is mentioned in shipment creation.
Create multiple warehouses for different locations. Each warehouse will have a unique sa_warehouse_identifier that you can use to specify pickup locations for different shipments.
After creating a warehouse in ShipAxis, you can link it to your marketplace warehouse using the \"Create Warehouse Source\" API endpoint:POST /api/v1/warehouses/{sa_warehouse_identifier}/warehouse_sources/create
The Get Warehouse Details API allows merchants to retrieve detailed information about a specific warehouse using its unique identifier. This includes all warehouse configuration, address details, and contact information.
\nHTTP Method: GET
Endpoint: /api/v1/warehouses/{sa_warehouse_identifier}/details
Status Code on Success: 200 OK
Authentication Required: Yes (Merchant API Key)
When a warehouse is successfully retrieved, the API returns:
\n{\n \"success\": true,\n \"message\": \"Warehouse fetched successfully\",\n \"data\": {\n \"sa_warehouse_identifier\": \"SA_a7f3e9d2c1b4f8e5a6d7c9b8e1f2a3d4e5f6a7b8_1234_400069\",\n \"is_active\": true,\n \"is_default\": false,\n \"title\": \"Mumbai Main Warehouse\",\n \"address_line_1\": \"123, Industrial Area, Andheri East\",\n \"address_line_2\": \"Near Metro Station\",\n \"landmark\": \"Opposite City Mall\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"pincode\": \"400069\",\n \"country\": \"India\",\n \"country_code\": \"IN\",\n \"latitude\": \"19.1136\",\n \"longitude\": \"72.8697\",\n \"contact_first_name\": \"Rajesh\",\n \"contact_last_name\": \"Kumar\",\n \"contact_email\": \"rajesh.kumar@example.com\",\n \"contact_phone_number\": \"+919876543210\",\n \"created_at\": \"2026-01-15T10:30:00+05:30\",\n \"modified_at\": \"2026-01-20T14:45:00+05:30\"\n },\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T10:29:53.123456+05:30\"\n}\n\nResponse Data Object Fields:
\nNote: Fields with null values are automatically excluded from the response.
\n{\n \"success\": false,\n \"message\": \"No matching Warehouse found\",\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T10:29:53.123456+05:30\"\n}\n\nNote: This error occurs when the provided sa_warehouse_identifier doesn't exist or you don't have access to it.
What to do with the response:
\nUse the warehouse details to display in your application UI
\nVerify the warehouse configuration before creating shipments
\nUpdate local cache/database with the latest warehouse information
\nUse the contact details for customer communication
\nUse the address details for shipping labels and documentation
\nThis endpoint retrieves a list of warehouses from the system. It supports pagination through the use of limit and offset query parameters.
jwt_token (string): A valid JSON Web Token required for authentication.
\nlimit (integer): This parameter specifies the maximum number of warehouse records to return in the response. It is useful for controlling the size of the data returned.
\noffset (integer): This parameter indicates the starting point from which to return warehouse records. It is used for pagination to skip a certain number of records.
\nGET https://api.example.com/api/v1/warehouses/list?jwt_token=<your_jwt_token>&limit=10&offset=0\n\nThe response will include a list of warehouses based on the specified limit and offset values, along with additional metadata about the request.
Ensure to use the limit and offset parameters effectively to manage the data returned by the API.
This endpoint retrieves a list of warehouses from the Shipaxis API.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","warehouses","list"],"host":["https://api.example.com"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"81647d92-afc2-412a-a9a2-77df4b41701f"},{"name":"Create Warehouse Source API","id":"ffa1fbec-111a-4c13-a150-5fdde847d27f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_category\": \"courier\",\n \"source_platform\": \"string\",\n \"source_warehouse_identifier\": \"string\",\n \"is_active_at_source\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/warehouses/:sa_warehouse_identifier/warehouse_sources/create","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","warehouses",":sa_warehouse_identifier","warehouse_sources","create"],"host":["https://api.example.com"],"query":[],"variable":[{"type":"any","value":"","key":"sa_warehouse_identifier"}]}},"response":[],"_postman_id":"ffa1fbec-111a-4c13-a150-5fdde847d27f"},{"name":"Get Warehouse Sources For Warehouse API","id":"f6bf9fb1-7e72-4250-a918-d0a7b81bc0eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/warehouses/:sa_warehouse_identifier/warehouse_sources/list","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","warehouses",":sa_warehouse_identifier","warehouse_sources","list"],"host":["https://api.example.com"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"offset","value":"0"}],"variable":[{"type":"any","value":"","key":"sa_warehouse_identifier"}]}},"response":[],"_postman_id":"f6bf9fb1-7e72-4250-a918-d0a7b81bc0eb"},{"name":"Create Package Dimension API","id":"a300a4e7-a736-4d8a-8aaf-2ba0e14a184b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_default\": false,\n \"name\": \"Default Package\",\n \"weight\": \"500\",\n \"length\": \"10\",\n \"breadth\": \"10\",\n \"height\": \"10\",\n \"is_enabled_for_automation\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/api/v1/warehouses/package_dimensions/create","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","warehouses","package_dimensions","create"],"host":["https://api.example.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a300a4e7-a736-4d8a-8aaf-2ba0e14a184b"},{"name":"Get All Package Dimensions API","id":"1934e102-9c44-4c7b-8c38-d08fc3bd034d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/api/v1/warehouses/package_dimensions/list","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}},"urlObject":{"path":["api","v1","warehouses","package_dimensions","list"],"host":["https://api.example.com"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"1934e102-9c44-4c7b-8c38-d08fc3bd034d"}],"id":"f5b0c2d1-a2b5-41b0-b816-2ce7a9a536a5","_postman_id":"f5b0c2d1-a2b5-41b0-b816-2ce7a9a536a5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","name":"Pragma APIs / Webhooks","type":"folder"}}}],"id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{API_KEY}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b0a61507-9640-4181-94ff-fe6d07458943","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b2feaed2-2191-410b-bfdf-9433d84b7e1e","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"45f3f4a8-7752-4113-a44a-04c3ef0f153a","description":""},{"name":"Client-side APIs / Webhooks","item":[],"id":"363e2e8f-8f72-4042-b8ca-e83e2dc8fcbe","_postman_id":"363e2e8f-8f72-4042-b8ca-e83e2dc8fcbe","description":""}],"id":"73bd5cab-6469-43de-89ca-5a880ac1c4f9","description":"ShipAxis by Pragma is a comprehensive shipping and logistics solution that streamlines your order fulfillment operations. This API documentation consists of the APIs you can use to integrate ShipAxis into your application.
\nhttps://api.example.com\n\nNote: This is example base URL. Contact ShipAxis support team to obtain ShipAxis API Base URL.
\nAll ShipAxis API requests require authentication using an API key passed in the request header.
\nInclude your API key in the X-API-Key header with every request:
Header Format:
\nX-API-Key: your_api_key_here\n\nExample Request:
\ncurl --location 'https://api.example.com/api/v1/warehouses/list' \\\n--header 'X-API-Key: your_api_key_here'\n\nContact the ShipAxis support team to obtain your API key. Once received, store it securely and use it to authenticate all API requests.
\nKeep your API key secure - Never commit API keys to version control or share them publicly
\nUse environment variables - Store API keys in environment variables, not in code
\nUse HTTPS only - All API requests must use HTTPS protocol
\nMonitor API usage - Regularly review API access logs for unauthorized usage
\nAll ShipAxis APIs follow a consistent response structure for both success and error cases.
\n{\n \"success\": true/false,\n \"message\": \"Human-readable message\",\n \"data\": {},\n \"error\": {},\n \"trace_id\": \"UUID\",\n \"timestamp\": \"ISO 8601 timestamp\"\n}\n\nImportant Notes:
\nFields with null or empty values are automatically excluded from responses
HTTP status code is returned in the response header, NOT in the response body
\nThe trace_id can be used for debugging and support requests
When an API request is successful, the response follows this structure:
\n{\n \"success\": true,\n \"message\": \"Operation completed successfully\",\n \"data\": {\n \"key\": \"value\"\n },\n \"trace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"timestamp\": \"2026-01-28T11:43:52.123456+05:30\"\n}\n\n{\n \"success\": true,\n \"message\": \"Warehouse created successfully\",\n \"data\": {\n \"sa_warehouse_identifier\": \"SA_xyz123abc...\"\n },\n \"trace_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"timestamp\": \"2026-01-28T11:43:52.456789+05:30\"\n}\n\n{\n \"success\": true,\n \"message\": \"Shipment fetched successfully\",\n \"data\": {\n \"order_id\": \"ORD-12345\",\n \"status\": \"in_transit\",\n \"awb_number\": \"AWB123456789\"\n },\n \"trace_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"timestamp\": \"2026-01-28T11:43:52.789012+05:30\"\n}\n\n{\n \"success\": true,\n \"message\": \"Warehouses fetched successfully\",\n \"data\": [\n {\n \"sa_warehouse_identifier\": \"SA_abc123...\",\n \"title\": \"Mumbai Warehouse\",\n \"is_active\": true\n },\n {\n \"sa_warehouse_identifier\": \"SA_def456...\",\n \"title\": \"Delhi Warehouse\",\n \"is_active\": true\n }\n ],\n \"trace_id\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"timestamp\": \"2026-01-28T11:43:52.345678+05:30\"\n}\n\nAll error responses follow a consistent format with detailed error information.
\n{\n \"success\": false,\n \"message\": \"Human-readable error message\",\n \"error\": {\n \"detail\": \"<error_details>\"\n },\n \"trace_id\": \"UUID for tracking\",\n \"timestamp\": \"ISO 8601 timestamp in IST\"\n}\n\nThe error.detail field structure varies based on the error type:
Note: Fields with null values are automatically excluded from error responses.
Scenario: Missing or invalid authentication credentials
\n{\n \"success\": false,\n \"message\": \"HTTP error occurred\",\n \"error\": {\n \"detail\": {\n \"type\": \"HTTPException\",\n \"info\": \"Missing X-API-Key header\"\n }\n },\n \"trace_id\": \"d4e5f6a7-b8c9-0123-def0-123456789abc\",\n \"timestamp\": \"2026-01-28T11:43:52.123456+05:30\"\n}\n\nCommon Reasons:
\nAPI key not provided in request header
\nInvalid API key format
\nExpired authentication token
\nResolution:
\nVerify that the correct authentication header is included
\nCheck that the API key/token is valid and active
\nEnsure the authentication value is correctly formatted
\nScenario: Valid credentials but insufficient permissions
\n{\n \"success\": false,\n \"message\": \"HTTP error occurred\",\n \"error\": {\n \"detail\": {\n \"type\": \"HTTPException\",\n \"info\": \"Insufficient permissions to access this resource\"\n }\n },\n \"trace_id\": \"e5f6a7b8-c9d0-1234-ef01-23456789abcd\",\n \"timestamp\": \"2026-01-28T11:43:52.234567+05:30\"\n}\n\nCommon Reasons:
\nAccount doesn't have required feature enabled
\nAPI key doesn't have permission for this operation
\nResource belongs to a different account
\nResolution:
\nContact ShipAxis support to enable required features
\nVerify you're accessing resources that belong to your account
\nCheck API key permissions and scope
\nScenario: Requested resource doesn't exist or is inaccessible
\n{\n \"success\": false,\n \"message\": \"No matching Warehouse found\",\n \"trace_id\": \"f6a7b8c9-d0e1-2345-f012-3456789abcde\",\n \"timestamp\": \"2026-01-28T11:43:52.345678+05:30\"\n}\n\nCommon Reasons:
\nInvalid resource identifier
\nResource has been deleted
\nYou don't have access to the resource
\nResolution:
\nVerify the resource identifier is correct
\nEnsure the resource exists and is active
\nCheck that you have permission to access this resource
\nScenario: Request data failed validation
\n{\n \"success\": false,\n \"message\": \"Validation Error\",\n \"error\": {\n \"detail\": [\n {\n \"type\": \"missing\",\n \"loc\": [\"body\", \"title\"],\n \"msg\": \"Field required\",\n \"input\": {}\n },\n {\n \"type\": \"string_pattern_mismatch\",\n \"loc\": [\"body\", \"contact_phone_number\"],\n \"msg\": \"String should match pattern '^\\\\+?1?\\\\d{9,15}$'\",\n \"input\": \"123\"\n }\n ]\n },\n \"trace_id\": \"a7b8c9d0-e1f2-3456-0123-456789abcdef\",\n \"timestamp\": \"2026-01-28T11:43:52.456789+05:30\"\n}\n\nValidation Error Detail Fields:
\ntype - Type of validation error (e.g., missing, string_pattern_mismatch, value_error)
loc - Location of the error in the request (e.g., [\"body\", \"field_name\"])
msg - Human-readable error message
input - The invalid value that was provided (if applicable)
Common Reasons:
\nMissing required fields
\nInvalid field format (e.g., email, phone number)
\nValue out of allowed range
\nInvalid data type
\nResolution:
\nCheck all required fields are provided
\nVerify field values match expected format/pattern
\nEnsure data types are correct (string, number, boolean, etc.)
\nReview API documentation for field requirements
\nScenario: Resource conflict or constraint violation
\n{\n \"success\": false,\n \"message\": \"Warehouse titled 'Mumbai Main Warehouse' already exists for pincode 400069\",\n \"error\": {\n \"detail\": \"Duplicate resource detected\"\n },\n \"trace_id\": \"b8c9d0e1-f2a3-4567-1234-56789abcdef0\",\n \"timestamp\": \"2026-01-28T11:43:52.567890+05:30\"\n}\n\nCommon Reasons:
\nAttempting to create a duplicate resource
\nConstraint violation (e.g., only one default allowed)
\nResource state conflict
\nResolution:
\nCheck if the resource already exists
\nUpdate existing resource instead of creating new one
\nResolve the business logic conflict
\nScenario: Unexpected server-side error
\n{\n \"success\": false,\n \"message\": \"Internal Server Error\",\n \"error\": {\n \"detail\": \"An unexpected error occurred\"\n },\n \"trace_id\": \"c9d0e1f2-a3b4-5678-2345-6789abcdef01\",\n \"timestamp\": \"2026-01-28T11:43:52.678901+05:30\"\n}\n\nCommon Reasons:
\nUnexpected server-side issue
\nDatabase connectivity problems
\nThird-party service unavailability
\nResolution:
\nRetry the request after a short delay
\nIf the issue persists, contact ShipAxis support
\nProvide the trace_id when reporting the issue for faster resolution
ShipAxis APIs may implement rate limiting to ensure fair usage and platform stability.
\nRate Limit Headers:
\nX-RateLimit-Limit: 1000\nX-RateLimit-Remaining: 999\nX-RateLimit-Reset: 1643723400\n\nRate Limit Exceeded (429 Too Many Requests):
\n{\n \"success\": false,\n \"message\": \"Rate limit exceeded\",\n \"error\": {\n \"detail\": {\n \"type\": \"RateLimitExceeded\",\n \"info\": \"Too many requests. Please retry after some time.\"\n }\n },\n \"trace_id\": \"d0e1f2a3-b4c5-6789-3456-789abcdef012\",\n \"timestamp\": \"2026-01-28T11:43:52.789012+05:30\"\n}\n\nBest Practices:
\nImplement exponential backoff for retries
\nCache responses when appropriate
\nBatch requests where possible
\nMonitor rate limit headers and adjust request frequency
\nList endpoints support pagination to manage large datasets efficiently.
\nRequest:
\nGET /api/v1/warehouses/list?limit=20&offset=40\n\nResponse:
\n{\n \"success\": true,\n \"message\": \"Warehouses fetched successfully\",\n \"data\": [\n { \"sa_warehouse_identifier\": \"SA_abc...\", \"title\": \"Warehouse 1\" },\n { \"sa_warehouse_identifier\": \"SA_def...\", \"title\": \"Warehouse 2\" }\n ],\n \"trace_id\": \"e1f2a3b4-c5d6-7890-4567-89abcdef0123\",\n \"timestamp\": \"2026-01-28T11:43:52.890123+05:30\"\n}\n\nAlways include authentication headers - Ensure the correct authentication header is present
\nUse HTTPS - All API requests should use secure HTTPS protocol
\nSet proper Content-Type - Use Content-Type: application/json for JSON payloads
Handle timeouts - Implement appropriate timeout handling (recommended: 30 seconds)
\nValidate before sending - Validate request data on client side before making API calls
\nCheck success field - Always check the success boolean before processing response
Handle all error codes - Implement handlers for all possible HTTP status codes
\nUse trace_id for debugging - Include trace_id when reporting issues to support
Parse error details - Extract meaningful information from error.detail for user feedback
Log responses - Log API responses for debugging and monitoring (exclude sensitive data)
\nImplement retry logic - Retry failed requests with exponential backoff for 5xx errors
\nShow user-friendly messages - Convert technical errors to user-friendly messages
\nDon't retry 4xx errors - Client errors typically won't succeed on retry (except 429)
\nMonitor error rates - Track and alert on increased error rates
\nPreserve trace_id - Store trace_id for failed requests for support escalation
For API integration support, technical assistance, or to report issues:
\nWhen contacting support, please provide:
\nAPI endpoint being called
\nRequest payload (sanitize sensitive data)
\nComplete error response including trace_id
Timestamp of the incident
\nExpected vs actual behavior
\nShipAxis APIs follow semantic versioning. The current API version is v1.
Version Format: /api/v{major}
Backward Compatibility:
\nMinor updates and bug fixes maintain backward compatibility
\nDeprecated features will be announced 90 days before removal
\nBreaking changes will be released as new major versions
\nStay Updated:
\nSubscribe to API changelog notifications
\nMonitor the documentation for updates
\nTest integrations in staging before production deployments
\nObtain API credentials from ShipAxis team
\nSet up authentication headers in your application
\nReview response format and error handling guidelines
\nImplement proper error handling and retry logic
\nTest API calls in development/staging environment
\nMonitor API usage and error rates
\nSet up logging with trace_id for debugging
Implement rate limit handling
\nReview security best practices
\nSet up monitoring and alerts for API health
\n