Skip to content

Instantly share code, notes, and snippets.

@ezzabuzaid

ezzabuzaid/oto.postman.json

Created May 29, 2025 06:25
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save ezzabuzaid/14bc73e2a230f00b61df56779e5cad32 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save ezzabuzaid/14bc73e2a230f00b61df56779e5cad32 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
oto.postman.json
{
"info": {
"_postman_id": "d4793dea-29c4-4fc5-87e8-e154093c84a7",
"name": "OTO API V2",
"description": "## Introduction\n\n**OTO REST API** provides seamless integration for managing shipments, tracking deliveries, and handling logistics operations. With powerful endpoints for creating, updating, and querying shipments, it ensures efficient and reliable communication between your systems and OTO's platform.\n\n## Overview\n\nWe continuously analyze the e-commerce and logistics industries to enhance shipping and fulfillment processes, making them easier for vendors. OTO APIs are designed to automate and simplify key logistics operations, including:\n\n🚀 **Order Management** – Process, update, and sync orders seamlessly. \n🚀 **Shipment Management** – Create, manage, and track shipments effortlessly. \n🚀 **Return Management** – Handle return requests and reverse logistics smoothly. \n🚀 **Stock & Inventory Management** – Keep inventory levels updated in real-time. \n🚀 **Product Management** – Organize, update, and synchronize products efficiently. \n🚀 **Warehouse Management** – Add, update, organize pickup locations.\n\nYou can find guidance to assist you throughout the integration process [here](https://help.tryoto.com/en/support/solutions/folders/150000543243).\n\n#### Base URL:\n\nAll API requests must be made over HTTPS to the following base endpoint:\n\n[https://api.tryoto.com](https://api.tryoto.com/rest/v2/)\n\n#### **Dev URL:**\n\n[https://staging-api.tryoto.com](https://staging-api.tryoto.com/rest/v2/)\n\n##### Please watch the [guide](https://www.youtube.com/watch?v=B6A7ndF3IRI) to create a test account.\n\n### Meet our new [OTO AI Assistant](https://app.tryoto.com/api-integrations/oto-api?modal=ai-assistant-chat&modalID=1748251297705) 🤖— a smart AI agent designed to help you navigate and use our REST API with ease. Whether you're integrating for the first time or need help troubleshooting a request, our assistant is here to provide instant answers, example json responses, guide you through endpoints, and help you build faster.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "3597319"
},
"item": [
{
"name": "Use Cases and Flows",
"item": [
{
"name": "Before Start",
"item": [],
"description": "Before you can create orders, generate shipments, or print Air Waybills (AWBs) in your OTO account, there are a few important setup steps you must complete. Follow this guide to ensure your account is fully activated and ready to operate smoothly.\n\n### 1\\. Verify Your Account\n\nAfter creating your OTO account:\n\n- Navigate to **Settings → My Profile**.\n \n- Verify your **phone number** and **email address** to complete your profile verification.\n \n\n---\n\n### 2\\. Activate Your Refresh Token\n\n- Go to **Settings → API Integrations**.\n \n- Click the **Connect** button to activate your **Refresh Token**.\n \n\n---\n\n### 3\\. Generate an Access Token\n\n- Use your refresh token to obtain an access token by sending a request to the **Refresh Token** endpoint:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/refreshToken\n\n ```\n\n---\n\n### 4\\. (Optional) Configure Delivery Company Integrations\n\nIf you have existing contracts with delivery companies and prefer using them instead of OTO’s rates:\n\n#### Step 1: Retrieve Available Delivery Companies\n\n- Get the list of integrated delivery companies:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/dcList\n\n ```\n\n- Identify the **company code** you want to configure.\n \n\n#### Step 2: Get the Configuration Template\n\n- Retrieve the required fields and credentials template for the selected delivery company:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/dcConfig\n\n ```\n\n#### Step 3: Activate Delivery Company Integration\n\n- Submit the completed configuration to activate the delivery company:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/dcActivation\n\n ```\n\n---\n\n### 5\\. (Optional) Create Pickup Locations\n\nIf you have fixed pickup locations:\n\n- Pre-save them in your account using the **Create Pickup Location** endpoint:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/createPickupLocation\n\n ```\n\n---\n\n### 6\\. Charge Your Wallet\n\nBefore creating shipments, ensure your account has enough balance. You have two options:\n\n- **Per shipment**: Calculate the required balance for each shipment using either:\n \n - `POST https://api.tryoto.com/rest/v2/checkOTODeliveryFee` (for OTO rates)\n \n - `POST https://api.tryoto.com/rest/v2/checkDeliveryFee` (for your own contract rates)\n \n- **Bulk top-up**: Add balance manually in advance.\n \n\nTo charge your wallet, use the **Buy Credit** endpoint:\n\n``` bash\nhttps://api.tryoto.com/rest/v2/buyCredit\n\n ```\n\n✅ Once all these steps are completed, you are ready to start creating shipments and using OTO’s full range of services!"
},
{
"name": "Create a Shipment",
"item": [],
"description": "### **Step 1: Create an Order**\n\nTo create a shipment, you must create an order in your OTO account. You can do this using the **`createOrder`** endpoint:\n\n``` bash\nhttps://api.tryoto.com/rest/v2/createOrder\n\n ```\n\n#### **Prerequisites: Provide Sender Information**\n\nWhen creating an order, you need to provide sender information. There are two methods, depending on your business needs:\n\n**Fixed Pickup Locations**:\n\n- Use createPickupLocation endpoint to create a pickup location.\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/createPickupLocation\n\n ```\n\n- After creating a pickup location, you’ll receive a **pickupLocationCode**, which you can use in the **`createOrder`** request, eliminating the need to enter sender address details every time.\n \n\n**Flexible Pickup Locations**:\n\n- If your addresses change frequently, skip the fixed pickup location creation and provide the sender details directly in the **`senderInformation`** object within the **`createOrder`** request.\n \n\n---\n\n### **Step 2: Create a Shipment**\n\nOnce your order is created, you can proceed to create a shipment. You can do this in two ways:\n\n#### **Create Shipment via** **`createShipment`** **endpoint:**\n\nUse the **`createShipment`** endpoint to create a shipment by providing the **`orderId`** and **`deliveryOptionId`**:\n\n``` bash\nhttps://api.tryoto.com/rest/v2/createShipment\n\n ```\n\nThere are two ways to determine the **`deliveryOptionId`**:\n\n**Delivery Options with OTO Rates**:\n\n- No contracted delivery companies or activation is required. OTO offers a range of delivery company options, which are available for use. You can view these options and their associated fees by using the Check OTO Delivery Fee endpoint and get the deliveryOptionId.\n \n\n``` bash\n https://api.tryoto.com/rest/v2/checkOTODeliveryFee\n\n ```\n\n**Delivery Options with Your Own Rates**:\n\n- If you have agreements with specific delivery companies, each one will have a linked **`deliveryOptionId`**. You can retrieve these IDs using the following endpoints:\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/checkOTODeliveryFee \n\n ```\n\n``` bash\nhttps://api.tryoto.com/rest/v2/checkDeliveryFee\n\n ```\n\n#### **Create Shipment via** **`createOrder`** **endpoint:**\n\nAlternatively, you can create the shipment directly during the **`createOrder`** step by adding a **`createShipment: true`** parameter in the request body:\n\n``` json\n{\n \"createShipment\": true\n}\n\n ```\n\nThis will automatically create the shipment without needing a separate **`createShipment`** call.\n\n---\n\n### **Step 3: Print AWB (Shipping Label)**\n\n#### **Print AWB via API**\n\nTo print the Air Waybill (AWB) for your shipment, use the **`print`** endpoint:\n\n``` bash\nhttps://api.tryoto.com/rest/v2/print/:orderId\n\n ```\n\nReplace **`:orderId`** with the actual order ID to retrieve the AWB URL for printing.\n\n#### **Print AWB via Webhook**\n\nTo receive AWB via webhooks, use the **`webhook`** endpoint:\n\n```\nhttps://api.tryoto.com/rest/v2/webhook\n\n ```\n\n- Set the **webhookType** to **`orderStatus`**.\n \n- Get the AWB with `printAWBURL` parameter.\n \n\n---\n\n### **Step 4: Track Your Shipment**\n\nYou can track shipments in two ways: using API endpoints or via webhooks.\n\n#### **Track Shipments via API**\n\n``` bash\nhttps://api.tryoto.com/rest/v2/orderStatus\n\n ```\n\nRetrieves details such as:\n\n- Current status (e.g., pickedUp, outForDelivery, delivered).\n \n- Shipment details, including carrier, tracking number, and estimated delivery time.\n \n- AWB URL.\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/orderHistory\n\n ```\n\n- Retrieves status changes (e.g., pickedUp, arrivedTerminal, delivered).\n \n- Provides timestamps for each status update and actions taken (e.g., cancellations or modifications).\n \n\n#### **Track Shipments via Webhook**\n\nTo receive real-time updates via webhooks, use the **`webhook`** endpoint:\n\n```\nhttps://api.tryoto.com/rest/v2/webhook\n\n ```\n\n- Set the **webhookType** to **`orderStatus`**.\n \n- Once configured, OTO will automatically send status updates to the provided webhook URL, notifying you of changes without the need to make additional requests.\n \n\n<img src=\"https://content.pstmn.io/62004f73-3581-43dc-b5b0-7a8d8e694605/Q1JFQVRFIEEgU0hJUE1FTlQgR1VJREVfZHJhd2lvICgxKS5wbmc=\">"
},
{
"name": "Marketplace Integration",
"item": [],
"description": "# Marketplace Integration Guide\n\nThis document outlines the roadmap for integrating marketplace companies with the OTO system. It provides a structured, step-by-step process to seamlessly onboard vendors/sellers, ensuring each is correctly registered, connected, and operational within the OTO ecosystem.\n\n### Vendor/Seller Management Models\n\nOTO offers two distinct approaches to managing vendors, allowing marketplaces to choose the model that best suits their operations:\n\n## 1\\. Manage Vendors/Sellers as Sub-Accounts\n\nIn this model, each vendor is registered as a **separate sub-account**, managed independently under a **main marketplace account**.\n\n### Steps to Set Up:\n\n**a. Obtain a Marketplace Token:**\n\nRequest a marketplace token from your OTO account manager or support team.\n\n**b. Get Access Token:**\n\nUse your marketplace token to request a fresh access token: \n\n``` bash\nhttps://api.tryoto.com/rest/v2/refreshToken\n\n ```\n\n**c. Register a Vendor/Seller:**\n\nAfter obtaining the access token, register vendors/sellers individually: \n`POST https://api.tryoto.com/rest/v2/register`\n\n⚡ _Important:_ Capture the **refresh token** returned for each seller. Each seller receives a unique refresh token, which must be used for all transactions related to that specific seller account.\n\n**d. Update Vendor/Seller Information:**\n\nTo update seller details, send a request to: \n\n``` bash\nPOST https://api.tryoto.com/rest/v2/clientInfo\n\n ```\n\n**e. Charge Vendor/Seller Accounts:**\n\nEach vendor manages their own wallet.\n\nTo add credit to a vendor account: \n\n``` bash\nhttps://api.tryoto.com/rest/v2/buyCredit\n\n ```\n\n**f. Check Vendor/Seller Balance:**\n\nRetrieve account balance information via: \n\n``` bash\nGET https://api.tryoto.com/rest/v2/clientInfo\n\n ```\n\n**g. Add Delivery Company Settings for Each Vendor**\n\nIf vendors have their own delivery company contracts, follow these steps:\n\n1. **Retrieve Delivery Companies List:** \n `GET https://api.tryoto.com/rest/v2/dcList`\n \n (Find the delivery company’s unique code.)\n \n2. **Get Delivery Company Configuration Template:** \n `POST https://api.tryoto.com/rest/v2/dcConfig`\n \n (Use the company code to retrieve the required configuration fields.)\n \n3. **Activate Delivery Company:** \n `POST https://api.tryoto.com/rest/v2/dcActivation`\n \n (Use the configuration object to activate the vendor’s delivery company.)\n \n\n## 2\\. Manage Vendors/Sellers Under One Main Account\n\nIn this model, vendors/sellers are managed centrally under a **single marketplace account**. Sellers are recorded as **Brands** and **Pickup Locations**.\n\n### Steps to Set Up:\n\n**a. Get a refresh token:**\n\nFrom your OTO account, click on the Settings menu and then the API integration menu. Click on the Connect button to create an API token. This token is your refresh token.\n\n**b. Get Access Token:**\n\nUse your refresh token to request a fresh access token: \n\n``` bash\nhttps://api.tryoto.com/rest/v2/refreshToken\n\n ```\n\n**c. Create Brands:**\n\nRegister each vendor as a brand: \n\n``` bash\nhttps://api.tryoto.com/rest/v2/createBrand\n\n ```\n\n- **Create Pickup Locations (Optional):** \n Save vendor addresses as pickup locations, linked to their brands, create a pickup location using the createPickupLocation endpoint and enter the brandName information you created in the brandName parameter.\n \n\n``` bash\nhttps://api.tryoto.com/rest/v2/createPickupLocation\n\n ```\n\nExample request:\n\n``` bash\n{\n \"brandName\": \"Vendor A\"\n}\n\n ```\n\n- **Specify Sender Address at Order Creation:**\n \n Alternatively, you can skip creating pickup locations and directly provide sender information in the order creation request via the `senderInformation` object at the `createOrder` endpoint.\n \n Fill the `storeName` field with the corresponding brand name.\n \n\n**d. Charge Main Account:**\n\nManage all transactions from a single wallet by charging the main account balance: \n\n``` bash\nhttps://api.tryoto.com/rest/v2/buyCredit\n\n ```\n\n---\n\n**e. Add Delivery Company Settings for Vendors Under Main Account**\n\nIf vendors have their own delivery company contracts:\n\n1. **Retrieve Delivery Companies List:** \n `GET https://api.tryoto.com/rest/v2/dcList`\n \n (Find the delivery company’s unique code.)\n \n2. **Get Delivery Company Configuration Template:** \n `POST https://api.tryoto.com/rest/v2/dcConfig`\n \n (Use the company code to retrieve the required configuration fields.)\n \n3. **Activate Delivery Company:** \n `POST https://api.tryoto.com/rest/v2/dcActivation`\n \n (Use the configuration object to activate the vendor’s delivery company.)\n \n\n🛎 **Important:**\n\nWhen activating a delivery company for a specific vendor, assign the related **brand** by using the `brandId` parameter in the DC Activation request.\n\nThis ensures you can differentiate delivery company contracts between vendors.\n\n<img src=\"https://content.pstmn.io/123f5e80-da2b-4a94-90af-18d3b2d9287b/bWFya2V0cGxhY2UgaW50ZWdyYXRpb24uZHJhd2lvICgxKS5wbmc=\">"
}
],
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [""]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [""]
}
}
]
},
{
"name": "Authorization",
"item": [
{
"name": "Refresh Token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = pm.response.json();\r",
"if(jsonData.access_token != undefined){\r",
" pm.environment.set(\"oto-token\", jsonData.access_token);\r",
"}\r",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"refresh_token\":\"AMf-vBwIRQZypzlW7dH-4a-gXlW1zw3VLXwoTvnePZPT5V6AnSESwhk9h4DKRMbDGGaSbDrbF-Tui21wq5PCI33HS7RaAapIFmwziKjIAAfAI2TUY3Vz5fKSlUwKUUKjfB5GTsBnFGjR1zdq9dryhPK88utLrE1-DSbRjfgdy4NNG6RTxk2ST0BplDKOdFN-y4ilOlI4rY7F\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/refreshToken",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "refreshToken"]
},
"description": "This API endpoint is used to obtain a new `access_token` by providing a valid `refresh_token`. The `access_token` is a temporary token with a lifespan of one hour, used to authenticate and authorize all subsequent API requests.\n\nInclude the `access_token` in the request headers as: \n`Authorization: Bearer access_token`\n\nTo adhere to security standards, it is recommended to renew the `access_token` periodically (every hour) to maintain uninterrupted access to the API while minimizing security risks. This endpoint ensures seamless and secure token management for applications relying on API interactions.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| refresh_token | yes | string | `refresh_token` can obtain token from the UI, this is permanent token, use only to get `access_token` |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"refresh_token\":\"_refresh_token_\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/refreshToken",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "refreshToken"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "text/plain;charset=iso-8859-1"
},
{
"key": "X-Cloud-Trace-Context",
"value": "5040bc2de0cdcc8f9bbaea8108d997f9;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 21 Sep 2021 14:39:30 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "1207"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"access_token\": \"_access_token_\",\n \"refresh_token\": \"_refresh_token_\",\n \"success\": true,\n \"token_type\": \"Bearer\",\n \"expires_in\": \"3600\"\n}"
}
]
},
{
"name": "Health Check",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/healthCheck",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "healthCheck"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint is used to check if the system is working properly"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/healthCheck",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "healthCheck"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "WWW-Authenticate",
"value": "Bearer realm=\"https://rest-api-gate-2zoj1r36.ew.gateway.dev/rest/v2/healthCheck\""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "73bb94d92619875946de4b001fb1cec2;o=1"
},
{
"key": "Date",
"value": "Wed, 13 Oct 2021 12:06:25 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "40"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"status\": \"ok\"\n}"
}
]
}
],
"description": "You need your `refresh_token` for authorization. You can obtain your token from the UI by following these steps:\n\n- Go to **Settings → API Integrations**.\n \n- Click the **Connect** button to activate your **Refresh Token**.\n \n\nThe `refresh_token` can only be used to get a new `access_token`.\n\nUse the `access_token` to call other API endpoints with the following header:",
"auth": {
"type": "noauth"
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [""]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [""]
}
}
]
},
{
"name": "Account",
"item": [
{
"name": "Account Info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/accountInfo",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "accountInfo"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint retrieves detailed information about the authenticated user's account. This includes general profile details, current subscription and balance of the account.\n\n**Note:** You can only see the account information that your token belongs to.\n\n**Response Body:**\n\n- name: full name of the account owner.\n \n- email: email address belong to the account.\n \n- mobile: mobile number belong to the account.\n \n- packageName: current subscription package name\n \n- remainingCredit: balance in account\n \n- remainingFreeShipments: number of free shipments offered in campaigns"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/accountInfo",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "accountInfo"]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"name\": \"Fatmanur Yavuz-37192\",\r\n \"packageName\": \"FreePackage\",\r\n \"remainingCredit\": 500,\r\n \"remainingFreeShipments\": \"30\",\r\n \"email\": \"[email protected]\",\r\n \"mobileNumber\": \"966512223311\"\r\n}"
}
]
},
{
"name": "Buy Credit",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"amount\": 13.50\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/buyCredit",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "buyCredit"]
},
"description": "**Available Packages:** All Packages\n\nProvide amount of credit you wanted to buy, this will response a `paymentURL and paymentID`.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| amount | yes | number | the amount of credit wanted to buy |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"amount\": 13.50\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/buyCredit",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "buyCredit"]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": true,\r\n \"paymentID\": \"chg_LV03G2920250933Jk9c2603152\",\r\n \"paymentURL\": \"https://checkout.tap.company/?mode=page&themeMode=&language=en&token=eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjY3ZTM5ZmI5OGE3Y2NkMWQwZGE1NzlhMSJ9.71AJo8AcbO96of1mbvGLZR7x2cnrcquiwJii0zOGLmE\"\r\n}"
}
]
},
{
"name": "Credit Transactions",
"request": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}/rest/v2/creditTransactions?perPage=50&page=1&minDate=2022-01-01&maxDate=2024-06-10",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "creditTransactions"],
"query": [
{
"key": "perPage",
"value": "50"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2022-01-01"
},
{
"key": "maxDate",
"value": "2024-06-10"
},
{
"key": "orderId",
"value": "3078872",
"disabled": true
}
]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides a powerful way to retrieve credit transaction records from your system. This endpoint supports pagination for efficient data retrieval and allows filtering based on minimum and maximum dates. Additionally, if an `orderId` is provided, the `maxDate` and `minDate` parameters become optional, enabling direct access to transactions associated with the specified order.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| perPage | yes | number | Credit transaction count in the response. Max limit 100 |\n| page | yes | number | Pagination number. You can iterate this field to get all items. |\n| minDate | yes (If there is no orderId) | date | Starting \"Transaction Date\" of your credit transactions in \"yyyy-mm-dd\" format. |\n| maxDate | yes (If there is no orderId) | date | Ending \"Transaction Date\" of your credit transactions in \"yyyy-mm-dd\" format. |\n| orderId | no | string | Order ID for transactions of a single Order |\n\n#### Response Body\n\nThe response will include a `success` flag indicating the status of the request, and an `orders` array containing transaction details. Each transaction object in the `orders` array includes the following properties:\n\n- `transactionType` (string) - Type of the transaction.\n \n- `remainingAmount` (number) - The remaining amount for the transaction.\n \n- `amount` (number) - The transaction amount.\n \n- `deliveryCompanyName` (string) - Name of the delivery company.\n \n- `orderID` (string) - ID of the order.\n \n- `shipmentID` (string) - ID of the shipment.\n \n- `description` (string) - Description of the transaction.\n \n- `ID` (number) - Unique ID of the transaction.\n \n- `transactionDate` (string) - Date of the transaction.\n \n- `otoOrderID` (number) - OTO (One-Time-Only) order ID.\n \n- `orderPaymentType` (string) - Payment type for the order.\n \n- `status` (string) - Status of the transaction.\n \n- `chargeType`(string) -Type of the charge(charge, additionalCharge, refund, partialRefund)\n \n- `shipmentType`(string)-Type of the shipment(forward, return, reverse)\n \n\nIn case of an empty result, the `orders` array will be empty with a `success` flag set to true."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"url": {
"raw": "https://api.tryoto.com/rest/v2/creditTransactions?perPage=50&page=1&minDate=2020-01-01&maxDate=2024-06-10",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "creditTransactions"],
"query": [
{
"key": "perPage",
"value": "50"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2020-01-01"
},
{
"key": "maxDate",
"value": "2024-06-10"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 02 Jul 2024 11:20:38 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "7878"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"transactions\": [\n {\n \"amount\": 19,\n \"orderID\": \"41590739\",\n \"deliveryCompanySettingsId\": 5564,\n \"description\": \"Shipment canceled. Delivery fees will be credited back to your account.\",\n \"transactionDate\": \"2024-09-16T11:26:01\",\n \"orderPaymentType\": \"cod\",\n \"shipmentType\": \"forward\",\n \"transactionType\": \"dcFee\",\n \"remainingAmount\": 85.9,\n \"deliveryCompanyName\": \"Deliver Now\",\n \"chargingType\": \"charge\",\n \"langKey\": \"dcFeeShipmentCanceledRevokedDescription\",\n \"shipmentID\": \"DNL05000049328\",\n \"ID\": 8294185,\n \"otoOrderID\": 10690509,\n \"status\": \"revoked\"\n },\n {\n \"amount\": 18,\n \"orderID\": \"OID-20980-1092\",\n \"deliveryCompanySettingsId\": 5551,\n \"description\": \"Canceled shipment. Delivery fee credited back to your account.\",\n \"transactionDate\": \"2024-09-24T10:40:43\",\n \"orderPaymentType\": \"paid\",\n \"shipmentType\": \"forward\",\n \"transactionType\": \"dcFee\",\n \"remainingAmount\": 51.8,\n \"deliveryCompanyName\": \"Aramex\",\n \"chargingType\": \"refund\",\n \"langKey\": \"dcFeeShipmentCanceledDescription\",\n \"shipmentID\": \"50162082692\",\n \"ID\": 8430556,\n \"otoOrderID\": 10748485,\n \"status\": \"canceled\"\n },\n {\n \"amount\": 0.9,\n \"orderID\": \"1203\",\n \"deliveryCompanySettingsId\": 3022,\n \"description\": \"OTO Fee Booked on shipment created\",\n \"transactionDate\": \"2024-09-01T11:37:10\",\n \"orderPaymentType\": \"cod\",\n \"transactionType\": \"otoFee\",\n \"remainingAmount\": 111.2,\n \"deliveryCompanyName\": \"OTO FLEX\",\n \"langKey\": \"otoFeeSearchingDriverDescription\",\n \"shipmentID\": \"0e073859\",\n \"ID\": 8057956,\n \"otoOrderID\": 10248079,\n \"status\": \"booked\"\n }\n ]\n}"
},
{
"name": "400 Invalid Date",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}/rest/v2/creditTransactions?perPage=50&page=1&minDate=asc&maxDate=2024-06-10",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "creditTransactions"],
"query": [
{
"key": "perPage",
"value": "50"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "asc"
},
{
"key": "maxDate",
"value": "2024-06-10"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 02 Jul 2024 11:06:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "63"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"1107\",\n \"otoErrorMessage\":\"minDate or maxDate is missing or invalid\"\n}"
},
{
"name": "200 No Result",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}/rest/v2/creditTransactions?perPage=50&page=1&minDate=2020-01-01&maxDate=2020-06-10",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "creditTransactions"],
"query": [
{
"key": "perPage",
"value": "50"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2020-01-01"
},
{
"key": "maxDate",
"value": "2020-06-10"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 02 Jul 2024 11:07:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "34"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"transactions\": []\n}"
}
]
}
]
},
{
"name": "Marketplace",
"item": [
{
"name": "Register",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"mobileNumber\":\"966559665498\",\r\n    \"fullName\":\"test vendor\",\r\n    \"email\":\"[email protected]\",\r\n \"companyName\":\"test company 987654\"}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/register",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "register"]
},
"description": "**Available Packages:** Marketplaces\n\nThis API endpoint is just for **marketplaces with multiple vendors**. Marketplaces can register their vendors to OTO with this endpoint. It requires a **special kind of token** provided by OTO. Regular refresh tokens will **not** work here.\n\nIf you are a market place you can use register endpoint to create an OTO account for your vendors.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| companyName | yes | string | Company name of your vendor |\n| email | yes | string | Email of your vendor.(e.g., [[email protected]](https://mailto:[email protected])) |\n| fullName | yes | string | Full name of your vendor |\n| mobileNumber | yes | string | Mobile number of your vendor |\n| crNumber | no | string | CR number of your vendor |\n| vatNumber | no | string | Vat number of your vendor |\n| billingAddress | no | string | Billing address of your vendor |\n| companyLogoURL | no | string | Company logo URL of your vendor |\n| webhookURL | no | string | Webhook URL of your vendor |\n| webhookMethod | no | string | `POST`,`GET` |\n| webhookSecretKey | no | string | Webhook secret key of your vendor |\n| currency | no | string | ISO 4217 three-letter code: SAR, USD |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"companyLogoURL\":\"https://i.pinimg.com/550x/4d/72/97/example.jpg\",\r\n \"billingAddress\":\"test st.\",\r\n \"crNumber\":\"100003030\",\r\n \"vatNumber\":\"123456789013030\",\r\n \"mobileNumber\":\"96688877304\",\r\n \"fullName\":\"Test 30\",\r\n \"email\":\"[email protected]\",\r\n \"companyName\":\"test company 30\",\r\n \"webhookURL\": \"\",\r\n \"webhookMethod\": \"\",\r\n \"webhookSecretKey\": \"\",\r\n \"currency\":\"SAR\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/register",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "register"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "1fbf1412d64e3a4ac3ee0f4b5c6ab666;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 12 Oct 2021 15:02:07 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "420"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"activationLink\": \"https://login.tryoto.com/XYZ\",\n \"refreshToken\": \"_refreshToken_\"\n}"
}
]
},
{
"name": "Client Info",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\":\"[email protected]\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/clientInfo",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "clientInfo"]
},
"description": "**Available Packages:** Marketplaces\n\nThis API endpoint is just for marketplaces. Marketplaces can register their vendors to OTO with a special kind of token provided by OTO. Regular refresh tokens will not work here.\n\nIf you are a marketplace and used register endpoint to create an OTO account for your vendors , you can get the information about the client you have registered.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| email | yes | string | registered email of client |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\":\"[email protected]\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/clientInfo",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "clientInfo"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "3c813ceaf2dbd0d9763206c5d247a06c;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 21 Sep 2021 15:34:05 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "6925"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"userActivated\": \"false\",\n \"remainingCredit\": 0,\n \"validityDate\": \"13-October-2028\",\n \"success\": true,\n \"refreshToken\": \"_refreshToken_\"\n}"
}
]
},
{
"name": "Client Info",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/clientInfo",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "clientInfo"]
},
"description": "**Available Packages:** Marketplaces\n\nThis API endpoint provides detailed information about a vendor's account and its current status. This endpoint returns essential client-related data, including contact details, account balances, and service validity, enabling seamless integration for managing and monitoring client activities.\n\n**Request Parameters:**\n\nNo request body parameters are required for this GET request.\n\n**Response:**\n\n``` json\n{\n \"remainingCredit\": 10,\n \"phone\": \"+966567130000\",\n \"validityDate\": \"11-01-2028\",\n \"success\": true,\n \"name\": \"test Company\",\n \"email\": \"[email protected]\"\n}\n\n ```"
},
"response": [
{
"name": "Client Info",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/clientInfo",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "clientInfo"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"remainingCredit\": 10,\n \"phone\": \"+966567130000\",\n \"validityDate\": \"11-01-2028\",\n \"success\": true,\n \"name\": \"test Company\",\n \"email\": \"[email protected]\",\n \"refreshToken\": \"_refreshToken_\"\n}"
}
]
}
]
},
{
"name": "Orders",
"item": [
{
"name": "Create Order",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [""],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [""],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\", \n \"pickupLocationCode\": \"jdd_wh\",\n \"createShipment\": \"true\",\n \"deliveryOptionId\": 564,\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"currency\": \"SAR\",\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"31/12/2022 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Jeddah\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint is a critical component in e-commerce and logistics systems, enabling external applications to initiate and manage new orders seamlessly. This endpoint allows you to submit order details, such as customer information, product data, shipping preferences, and payment methods.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the Order |\n| parentOrderId | no | string | parent id of splitted orders. |\n| ref1 | no | string | Reference for order optional |\n| pickupLocationCode | no | string | predefined pickup address of stores/warehouses, if it doesn't exist then OTO will assign it to a pickup location automatically. it is required when `serviceType` is filled `pickupFromStore` |\n| createShipment | no | boolean | if you fill it `true` then automatic shipment will be created for this order. |\n| serviceType | no | string | `pickupFromStore` this is optional for orders customer pick it up from store. |\n| forReverseShipment | no | boolean | if it is true, order can be reverse shipped without forward shipment |\n| deliveryOptionId | no | string | activated delivery company option id, if this exists OTO try to create shipment with this settings. if not exists try with possible active settings. |\n| storeName | no | string | Name of the store |\n| pickingType | no | enum | Possible values: <br>PICKUP_BY_DC: Shipping company offers free pickup from origin. BRANCH_DROP_OFF: Package must be delivered to a branch of the shipping company. |\n| payment_method | yes | string | Possible values: - _cod_ - _paid_ |\n| amount | yes | double | Total value amount of the order |\n| amount_due | yes | double | Total due amount of the order. If order paid amount_due will be 0. Otherwise equal to amount. |\n| currency | yes | string | Currency code of the order currency |\n| shippingAmount | no | double | shipping amount of this order |\n| subtotal | no | double | Subtotal of the order |\n| shippingNotes | no | string | Notes of customer for shipping. I.e `don’t ring the bell.` |\n| packageSize | no | string | Used for specifiying the maximum package size. Possible values smalbox |\n| packageCount | no | integer | States how many package in the order |\n| packageWeight | no | double | Total weight of the order |\n| boxWidth | conditional | double | width of the package, it is needed to use Aggregator shipping options |\n| boxLength | conditional | double | length of the package, it is needed to use Aggregator shipping options |\n| boxHeight | conditional | double | height of the package, it is needed to use Aggregator shipping options |\n| deliverySlotDate | no | date | Prefered `Delivery` date |\n| deliverySlotFrom | no | string | “From” time for delivery time |\n| deliverySlotTo | no | string | “To” time for delivery time |\n| orderDate | no | dateTime | Date of the order |\n| senderName | no | string | Sender name |\n| senderInformation | no | object | Sender Data |\n| customer | yes | object | Customer Data |\n| items | yes | array | Items data |\n| couponCode | no | text | Discount or special offer code. |\n| codFee | no | double | COD Fee |\n| brandId | no | long | Brand (Client Store) ID |\n| whoPays | no | string | If implemented, annotates who wil pay for the shipment. Possible values: marketplacePaysDeliveryFee, sellerPaysDeliveryFee |\n\n**Request Parameters for Sender Information Data**\n\n| **Name** | **Required** | **Type** | **Description** |\n| --- | --- | --- | --- |\n| senderAddressName | no | string | Name of the sender address |\n| senderId | yes | string | Id of the sender |\n| senderFullName | yes | string | Full name of the sender |\n| senderMobile | yes | string | Mobile number of sender |\n| senderEmail | no | string | In format of [[email protected]](https://mailto:[email protected]) |\n| senderCountry | yes | string | Country ISO2 code \"SA\",\"AE\" etc. |\n| senderState | no | string | State name of the sender |\n| senderCity | yes | string | City name of the sender |\n| senderDistrict | no | string | District name of the sender |\n| senderPostcode | no | string | Postal code of the sender's address |\n| senderAdressLine | yes | string | Detailed address of the sender |\n| lat | no | number | Latitude, \\*if not exist orders may not assigned to pickupLocations automatically |\n| lon | no | number | Longitude, \\* if not exist orders may not assigned to pickupLocations automatically |\n\n**Request Parameters for Customer Data**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | yes | string | Customer full name |\n| email | no | string | Customer email address |\n| mobile | yes | string | Mobile number of the customer |\n| address | yes | string | Address of the customer |\n| district | no | string | District or area name |\n| city | yes | string | City name |\n| state | no | string | State name |\n| country | yes | string | Possible values can be _SA_,_EG_,_UAE_,_BHR_,_KWT_ |\n| shortAddressCode | no | string | A simplified version of the traditional address transformed into a unique code. It consists of 4 letters (e.g., RAGI) assigned based on postal codes and 4 digits representing the building number (e.g., 2929). |\n| postcode | no | string | postal code of address |\n| street | no | string | Street of the customer |\n| lat | no | double | Latitude |\n| lon | no | double | Longitude |\n| refID | no | string | exp. customerId of ecommerce |\n| W3WAddress | no | string | if you want to define the address with using [what3words.com](https://what3words.com/clear.clear.clear) you can use this option |\n\n**Request Parameters for Items Data**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| productId | no | long | Id of the product |\n| name | yes | string | Name of the product |\n| price | yes | double | Unit price of the product |\n| rowTotal | no | double | total amount of this line item |\n| taxAmount | no | double | tax amount of this line item |\n| quantity | yes | double | Quantity purchased |\n| serialnumber | no | string | Serial number of the product |\n| sku | yes | string | SKU number of the product |\n| image | no | string | Http link of the product main photo |\n| hsCode | no | string | a standardized numerical method of classifying traded products |\n| itemOrigin | no | string | Origin of the item |"
},
"response": [
{
"name": "200 sender information",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"12347772\",\n \"ref1\": \"1234ABCDE\",\n \"deliveryOptionId\": \"12364\",\n \"serviceType\": \"\",\n \"createShipment\": false,\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"senderInformation\":{\n \"senderAddressName\":\"Home - John Doe\",\n \"senderId\":\"123452\",\n \"senderFullName\":\"John Doe\",\n \"senderMobile\":\"905055055555\",\n \"senderEmail\":\"[email protected]\",\n \"senderCountry\":\"SA\",\n \"senderCity\":\"Riyadh\", \n \"senderPostcode\":\"11564\",\n \"senderAddressLine\":\"الفرعي،، الطريق الدائري الجنوبي حي العزيزية،, Riyadh 11564, Saudi Arabia\",\n \"lat\":\"24.7310685013539\",\n \"lon\":\"46.70160835803429\"\n\n },\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"\",\n \"city\": \"Jeddah\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"serialnumber\": \"ASD12312121333\",\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 13:31:15 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "31"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 540789\n}"
},
{
"name": "200 pick up from store order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"\",\n \"serviceType\": \"pickupFromStore\",\n \"createShipment\": false,\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"\",\n \"city\": \"Jeddah\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"serialnumber\": \"ASD12312121333\",\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 13:31:15 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "31"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 540789\n}"
},
{
"name": "200 paid order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"\",\n \"serviceType\": \"\",\n \"createShipment\": false,\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"\",\n \"city\": \"Jeddah\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"serialnumber\": \"ASD12312121333\",\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 13:31:15 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "31"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 540789\n}"
},
{
"name": "200 cod order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"\",\n \"serviceType\": \"\",\n \"createShipment\": false,\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"cod\",\n \"amount\": 100,\n \"amount_due\": 100,\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingAmount\"20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"\",\n \"city\": \"Jeddah\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"serialnumber\": \"ASD12312121333\",\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 13:31:15 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "31"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 540789\n}"
},
{
"name": "200 order box",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImQ0OWU0N2ZiZGQ0ZWUyNDE0Nzk2ZDhlMDhjZWY2YjU1ZDA3MDRlNGQiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1OTgwIiwiY2xpZW50VHlwZSI6IlNjYWxlUGFja2FnZSIsIm1hcmtldFBsYWNlTmFtZSI6Im90b2FwaSIsInVzYWdlTW9kZSI6InJlYWwiLCJzdG9yZU5hbWUiOiJURVNUIiwidXNlclR5cGUiOiJzYWxlc0NoYW5uZWwiLCJ1c2VySWQiOiI5ODg1Iiwic2NjSWQiOiIyODUwIiwiZW1haWwiOiI1OTgwLTI4NTAtb3RvYXBpQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE2ODY4MzUzNzcsInVzZXJfaWQiOiI3dHNScjZMcU5WWkJuOWU1bmswVThQV2d4a1UyIiwic3ViIjoiN3RzUnI2THFOVlpCbjllNW5rMFU4UFdneGtVMiIsImlhdCI6MTY5OTE3MzA1MSwiZXhwIjoxNjk5MTc2NjUxLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiNTk4MC0yODUwLW90b2FwaUB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.PIsnK4gUBdBcT-4e-HCDrOsKXnNCPkQ9EWVRPLxLcu7EeaOTGSXZlBQ0IPLO8-6nSwIPiN-2yGBO0VDk0Onqj9pk0wObk2UuCI3nNj9QlgSEzpG-JvcGGAq8FjgC5QIo5epEEP42oYJFBXoNiZeMlooY59m9gh1ftuxM4aYffybb21yK8NxDo-CW68KdU030xkFtn-habvzT7EVakXWq9mMGVqYmFg-LIzs6nS5YNusSqx0bl2ABRAmjbqCKvUFSS3MzYNjHlUiT6H6EAwwlkpeLqdtuU_NhQAi4Aw7COGwGaFmpKnDeywBI1q2LiN3FBXiLyrcn5ft-N1osY_v_rg",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post1368479842164864545483\",\n \"entityId\": \"12\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"COD\",\n \"amount\": 300.41,\n \"amount_due\": 185,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxes\": [\n {\n \"dimensions\": {\n \"width\": 10,\n \"length\": 10,\n \"height\": 10\n },\n \"weight\": 2,\n \"boxName\": \"Box1\"\n }\n ],\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"asdasdas\",\n \"refID\": \"123\",\n \"email\": \"asdasd\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"123\",\n \"lon\": \"123\"\n },\n \"items\": [\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "a41f87e3141b894aaba774cece0a0f61;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 10 Mar 2024 07:29:31 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "33"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 30829625\n}"
},
{
"name": "200 with multiple order boxes",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImQ0OWU0N2ZiZGQ0ZWUyNDE0Nzk2ZDhlMDhjZWY2YjU1ZDA3MDRlNGQiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1OTgwIiwiY2xpZW50VHlwZSI6IlNjYWxlUGFja2FnZSIsIm1hcmtldFBsYWNlTmFtZSI6Im90b2FwaSIsInVzYWdlTW9kZSI6InJlYWwiLCJzdG9yZU5hbWUiOiJURVNUIiwidXNlclR5cGUiOiJzYWxlc0NoYW5uZWwiLCJ1c2VySWQiOiI5ODg1Iiwic2NjSWQiOiIyODUwIiwiZW1haWwiOiI1OTgwLTI4NTAtb3RvYXBpQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE2ODY4MzUzNzcsInVzZXJfaWQiOiI3dHNScjZMcU5WWkJuOWU1bmswVThQV2d4a1UyIiwic3ViIjoiN3RzUnI2THFOVlpCbjllNW5rMFU4UFdneGtVMiIsImlhdCI6MTY5OTE3MzA1MSwiZXhwIjoxNjk5MTc2NjUxLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiNTk4MC0yODUwLW90b2FwaUB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.PIsnK4gUBdBcT-4e-HCDrOsKXnNCPkQ9EWVRPLxLcu7EeaOTGSXZlBQ0IPLO8-6nSwIPiN-2yGBO0VDk0Onqj9pk0wObk2UuCI3nNj9QlgSEzpG-JvcGGAq8FjgC5QIo5epEEP42oYJFBXoNiZeMlooY59m9gh1ftuxM4aYffybb21yK8NxDo-CW68KdU030xkFtn-habvzT7EVakXWq9mMGVqYmFg-LIzs6nS5YNusSqx0bl2ABRAmjbqCKvUFSS3MzYNjHlUiT6H6EAwwlkpeLqdtuU_NhQAi4Aw7COGwGaFmpKnDeywBI1q2LiN3FBXiLyrcn5ft-N1osY_v_rg",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post136847984216486483\",\n \"entityId\": \"12\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"COD\",\n \"amount\": 300.41,\n \"amount_due\": 185,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxes\": [\n {\n \"dimensions\": {\n \"width\": 10,\n \"length\": 10,\n \"height\": 10\n },\n \"weight\": 2,\n \"boxName\": \"Box1\"\n },\n {\n \"dimensions\": {\n \"width\": 20,\n \"length\": 20,\n \"height\": 20\n },\n \"weight\": 3,\n \"boxName\": \"Box2\"\n }\n ],\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"asdasdas\",\n \"refID\": \"123\",\n \"email\": \"asdasd\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"123\",\n \"lon\": \"123\"\n },\n \"items\": [\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"rowTotal\": 100,\n \"taxAmount\": 15,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "d97bdd2d3e4dc96844f567faf9db6832;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 10 Mar 2024 07:28:51 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "33"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 30829624\n}"
},
{
"name": "200 update Order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImQ0OWU0N2ZiZGQ0ZWUyNDE0Nzk2ZDhlMDhjZWY2YjU1ZDA3MDRlNGQiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1OTgwIiwiY2xpZW50VHlwZSI6IlNjYWxlUGFja2FnZSIsIm1hcmtldFBsYWNlTmFtZSI6Im90b2FwaSIsInVzYWdlTW9kZSI6InJlYWwiLCJzdG9yZU5hbWUiOiJURVNUIiwidXNlclR5cGUiOiJzYWxlc0NoYW5uZWwiLCJ1c2VySWQiOiI5ODg1Iiwic2NjSWQiOiIyODUwIiwiZW1haWwiOiI1OTgwLTI4NTAtb3RvYXBpQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE2ODY4MzUzNzcsInVzZXJfaWQiOiI3dHNScjZMcU5WWkJuOWU1bmswVThQV2d4a1UyIiwic3ViIjoiN3RzUnI2THFOVlpCbjllNW5rMFU4UFdneGtVMiIsImlhdCI6MTY5OTE3MzA1MSwiZXhwIjoxNjk5MTc2NjUxLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiNTk4MC0yODUwLW90b2FwaUB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.PIsnK4gUBdBcT-4e-HCDrOsKXnNCPkQ9EWVRPLxLcu7EeaOTGSXZlBQ0IPLO8-6nSwIPiN-2yGBO0VDk0Onqj9pk0wObk2UuCI3nNj9QlgSEzpG-JvcGGAq8FjgC5QIo5epEEP42oYJFBXoNiZeMlooY59m9gh1ftuxM4aYffybb21yK8NxDo-CW68KdU030xkFtn-habvzT7EVakXWq9mMGVqYmFg-LIzs6nS5YNusSqx0bl2ABRAmjbqCKvUFSS3MzYNjHlUiT6H6EAwwlkpeLqdtuU_NhQAi4Aw7COGwGaFmpKnDeywBI1q2LiN3FBXiLyrcn5ft-N1osY_v_rg",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"OID-9616-98798\",\n \"entityId\": \"12\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"paid\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"Kılıf\",\n \"refID\": \"123\",\n \"email\": \"[email protected]\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"123\",\n \"lon\": \"123\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "79f672a9e47909bce14e2e9816246b14;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 15 Nov 2023 06:39:00 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "172"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"Order already exists, now the updating process begins for the specified order with order id: OID-9616-98798\"\n ],\n \"message\": \"Successfully updated\"\n}"
},
{
"name": "200 update but status is not valid for update",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImQ0OWU0N2ZiZGQ0ZWUyNDE0Nzk2ZDhlMDhjZWY2YjU1ZDA3MDRlNGQiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1OTgwIiwiY2xpZW50VHlwZSI6IlNjYWxlUGFja2FnZSIsIm1hcmtldFBsYWNlTmFtZSI6Im90b2FwaSIsInVzYWdlTW9kZSI6InJlYWwiLCJzdG9yZU5hbWUiOiJURVNUIiwidXNlclR5cGUiOiJzYWxlc0NoYW5uZWwiLCJ1c2VySWQiOiI5ODg1Iiwic2NjSWQiOiIyODUwIiwiZW1haWwiOiI1OTgwLTI4NTAtb3RvYXBpQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE2ODY4MzUzNzcsInVzZXJfaWQiOiI3dHNScjZMcU5WWkJuOWU1bmswVThQV2d4a1UyIiwic3ViIjoiN3RzUnI2THFOVlpCbjllNW5rMFU4UFdneGtVMiIsImlhdCI6MTY5OTE3MzA1MSwiZXhwIjoxNjk5MTc2NjUxLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiNTk4MC0yODUwLW90b2FwaUB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.PIsnK4gUBdBcT-4e-HCDrOsKXnNCPkQ9EWVRPLxLcu7EeaOTGSXZlBQ0IPLO8-6nSwIPiN-2yGBO0VDk0Onqj9pk0wObk2UuCI3nNj9QlgSEzpG-JvcGGAq8FjgC5QIo5epEEP42oYJFBXoNiZeMlooY59m9gh1ftuxM4aYffybb21yK8NxDo-CW68KdU030xkFtn-habvzT7EVakXWq9mMGVqYmFg-LIzs6nS5YNusSqx0bl2ABRAmjbqCKvUFSS3MzYNjHlUiT6H6EAwwlkpeLqdtuU_NhQAi4Aw7COGwGaFmpKnDeywBI1q2LiN3FBXiLyrcn5ft-N1osY_v_rg",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post1234s\",\n \"entityId\": \"12\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"paid\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"Kılıf\",\n \"refID\": \"123\",\n \"email\": \"[email protected]\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"123\",\n \"lon\": \"123\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "6477284d50d0ac434e77a21fc2ea6281"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 15 Nov 2023 06:35:20 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "155"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"errorCode\": 5,\n \"message\": \"Successfully updated. Due to status only ref* updated\",\n \"errorMsg\": \"Order Status delivered not allowed for update\"\n}"
},
{
"name": "200 split order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post{{ID}}\",\n \"entityId\": \"{{ID}}\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"{{$randomFullName}}\",\n \"refID\": \"123\",\n \"email\": \"{{$randomExampleEmail}}\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"{{riyadhLat}}\",\n \"lon\": \"{{riyadhLon}}\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\" :[\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 1\n },\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 2\n }\n ],\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 05 Nov 2023 07:03:17 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\"\n ],\n \"otoIds\": [\n 30794446,\n 30794447\n ]\n}"
},
{
"name": "200 split Order multiple items",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post{{ID}}\",\n \"entityId\": \"{{ID}}\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"{{$randomFullName}}\",\n \"refID\": \"123\",\n \"email\": \"{{$randomExampleEmail}}\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"{{riyadhLat}}\",\n \"lon\": \"{{riyadhLon}}\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\" :[\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 1\n },\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 2\n }\n ],\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n },\n {\n \"productId\": 112,\n \"name\": \"test without split\",\n \"price\": 152,\n \"quantity\": 2,\n \"serialNumber\" : \"ASD1231212133332\",\n \"sku\": \"0747027564101231\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 05 Nov 2023 07:20:04 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\"\n ],\n \"otoIds\": [\n 30794452,\n 30794453\n ]\n}"
},
{
"name": "200 split order with order boxes for each split item",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImQ0OWU0N2ZiZGQ0ZWUyNDE0Nzk2ZDhlMDhjZWY2YjU1ZDA3MDRlNGQiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1OTgwIiwiY2xpZW50VHlwZSI6IlNjYWxlUGFja2FnZSIsIm1hcmtldFBsYWNlTmFtZSI6Im90b2FwaSIsInVzYWdlTW9kZSI6InJlYWwiLCJzdG9yZU5hbWUiOiJURVNUIiwidXNlclR5cGUiOiJzYWxlc0NoYW5uZWwiLCJ1c2VySWQiOiI5ODg1Iiwic2NjSWQiOiIyODUwIiwiZW1haWwiOiI1OTgwLTI4NTAtb3RvYXBpQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE2ODY4MzUzNzcsInVzZXJfaWQiOiI3dHNScjZMcU5WWkJuOWU1bmswVThQV2d4a1UyIiwic3ViIjoiN3RzUnI2THFOVlpCbjllNW5rMFU4UFdneGtVMiIsImlhdCI6MTY5OTE3MzA1MSwiZXhwIjoxNjk5MTc2NjUxLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiNTk4MC0yODUwLW90b2FwaUB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.PIsnK4gUBdBcT-4e-HCDrOsKXnNCPkQ9EWVRPLxLcu7EeaOTGSXZlBQ0IPLO8-6nSwIPiN-2yGBO0VDk0Onqj9pk0wObk2UuCI3nNj9QlgSEzpG-JvcGGAq8FjgC5QIo5epEEP42oYJFBXoNiZeMlooY59m9gh1ftuxM4aYffybb21yK8NxDo-CW68KdU030xkFtn-habvzT7EVakXWq9mMGVqYmFg-LIzs6nS5YNusSqx0bl2ABRAmjbqCKvUFSS3MzYNjHlUiT6H6EAwwlkpeLqdtuU_NhQAi4Aw7COGwGaFmpKnDeywBI1q2LiN3FBXiLyrcn5ft-N1osY_v_rg",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post78567857857684864\",\n \"entityId\": \"64849468484\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"Furkan\",\n \"refID\": \"123\",\n \"email\": \"[email protected]\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"123\",\n \"lon\": \"123\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\": [\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\": 1,\n \"box\": {\n \"dimensions\": {\n \"width\": 10,\n \"length\": 10,\n \"height\": 10\n },\n \"weight\": 10,\n \"boxName\": \"newBox\"\n }\n },\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\": 2,\n \"box\": {\n \"dimensions\": {\n \"width\": 10,\n \"length\": 10,\n \"height\": 10\n },\n \"weight\": 20\n }\n }\n ],\n \"serialNumber\": \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n },\n {\n \"productId\": 112,\n \"name\": \"test without split\",\n \"price\": 152,\n \"quantity\": 2,\n \"serialNumber\": \"ASD1231212133332\",\n \"sku\": \"0747027564101231\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "d14421ffdfedb879b54acb33a1aac84e;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 10 Mar 2024 07:27:46 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\"\n ],\n \"otoIds\": [\n 30829622,\n 30829623\n ]\n}"
},
{
"name": "400",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"12364\",\n \"serviceType\": \"pickupFromStore\",\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1029\",\n \"otoErrorMessage\":\"Recipient name is missing or invalid\"\n}"
},
{
"name": "400 split Order wrong quantity",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post{{ID}}\",\n \"entityId\": \"{{ID}}\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"{{$randomFullName}}\",\n \"refID\": \"123\",\n \"email\": \"{{$randomExampleEmail}}\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"{{riyadhLat}}\",\n \"lon\": \"{{riyadhLon}}\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\" :[\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 1\n },\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 1\n }\n ],\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 05 Nov 2023 07:02:12 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "373"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\",\n \"sum of objects in the pickupLocation array is bigger than the total quantity of the item. Split order process has been revoked \"\n ],\n \"otoErrorCode\":\"OTO1071\",\n \"otoErrorMessage\":\"Item has pickupLocation array for split order process but the input is invalid in the array.\"\n}"
},
{
"name": "400 split order wrong pickupLocationCode",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post{{ID}}\",\n \"entityId\": \"{{ID}}\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"{{$randomFullName}}\",\n \"refID\": \"123\",\n \"email\": \"{{$randomExampleEmail}}\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"{{riyadhLat}}\",\n \"lon\": \"{{riyadhLon}}\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\" :[\n {\n \"pickupLocationCode\": \"asd\",\n \"quantity\" : 1\n },\n {\n \"pickupLocationCode\": \"WHA\",\n \"quantity\" : 2\n }\n ],\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 05 Nov 2023 07:03:40 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "361"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\",\n \"Both the order pickupLocationCode and item's pickupLocationCode do not exist. Split order process has been revoked \"\n ],\n \"otoErrorCode\":\"OTO1071\",\n \"otoErrorMessage\":\"Item has pickupLocation array for split order process but the input is invalid in the array.\"\n}"
},
{
"name": "400 split order invalid fields",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"post{{ID}}\",\n \"entityId\": \"{{ID}}\",\n \"serviceType\": \"returnFromCustomer\",\n \"forReverseShipment\": true,\n \"deliveryOptionId\": 2154,\n \"storeName\": \"POSTMAN\",\n \"payment_method\": \"applePay\",\n \"amount\": 300.41,\n \"amount_due\": 0,\n \"shippingAmount\": 10.41,\n \"subtotal\": 290.00,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"postman orders, be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 1,\n \"packageWeight\": 2.75,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"13/07/2023 15:45\",\n \"deliverySlotDate\": \"15/07/2023\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"metadata\": {\n \"paymentRef\": \"ref\"\n },\n \"customer\": {\n \"name\": \"{{$randomFullName}}\",\n \"refID\": \"123\",\n \"email\": \"{{$randomExampleEmail}}\",\n \"mobile\": \"555666555\",\n \"address\": \"8645 Istanbul St, As Sulay \",\n \"postcode\": \"14322\",\n \"district\": \"As Sulay\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"{{riyadhLat}}\",\n \"lon\": \"{{riyadhLon}}\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 50.55,\n \"quantity\": 3,\n \"pickupLocation\" :[\n {\n \"pickupLocationCode\": \"asd\",\n \"quantity\" : 1\n },\n {\n \"pickupLocationCode\": \"WHA\"\n }\n ],\n \"serialNumber\" : \"ASD12312121333\",\n \"sku\": \"0747027564101\",\n \"image\": \"https://i.pinimg.com/564x/4b/46/de/4b46de036e796592bc7fa30e1e73b3ab.jpg\",\n \"metadata\": {\n \"colorCode\": \"VT-0070\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 05 Nov 2023 07:05:06 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "361"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"warnings\": [\n \"pickupLocation field exists in the items array, split order process begins\",\n \"Both the order pickupLocationCode and item's pickupLocationCode do not exist. Split order process has been revoked \"\n ],\n \"otoErrorCode\":\"OTO1071\",\n \"otoErrorMessage\":\"Item has pickupLocation array for split order process but the input is invalid in the array.\"\n}"
},
{
"name": "401",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1234\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"12364\",\n \"serviceType\": \"pickupFromStore\",\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderName\":\"Sender Company\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createOrder"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
}
]
},
{
"name": "Update Order",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [""],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [""],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"202111081227\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"12364\",\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2022 15:45\",\n \"deliverySlotDate\": \"31/12/2022\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateOrder"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you update order info with this endpoint before shipment creation. If you created a shipment and need to update an information after that you have to cancel the shipment first then you can update."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"202111081227\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"12364\",\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2020 15:45\",\n \"deliverySlotDate\": \"31/12/2020\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "39ccd2317d3c01a5548073a3ca31383b;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 10:41:22 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "2"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "\r\n{\r\n \"success\":true,\r\n\t\"message\": \"Successfully updated\"\r\n}"
},
{
"name": "200 update branch",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"1174\",\n \"ref1\": \"1234ABCDE\",\n \"pickupLocationCode\": \"12364\",\n \"deliveryOptionId\": \"12364\",\n \"storeName\": \"Brand A English\",\n \"payment_method\": \"paid\",\n \"amount\": 100,\n \"amount_due\": 0,\n \"shippingAmount\":20,\n \"subtotal\":100,\n \"currency\": \"SAR\",\n \"customsValue\":\"12\",\n \"customsCurrency\":\"USD\",\n \"shippingNotes\": \"be careful. it is fragile\",\n \"packageSize\": \"small\",\n \"packageCount\": 2,\n \"packageWeight\": 1,\n \"boxWidth\": 10,\n \"boxLength\": 10,\n \"boxHeight\": 10,\n \"orderDate\": \"30/12/2022 15:45\",\n \"deliverySlotDate\": \"31/12/2022\",\n \"deliverySlotTo\": \"12pm\",\n \"deliverySlotFrom\": \"2:30pm\",\n \"senderInformation\":{\n \"senderAddressName\":\"Home - John Doe\",\n \"senderId\":\"12345\",\n \"senderFullName\":\"John Doe\",\n \"senderMobile\":\"905055055555\",\n \"senderEmail\":\"[email protected]\",\n \"senderCountry\":\"SA\",\n \"senderCity\":\"Riyadh\", \n \"senderPostcode\":\"11564\",\n \"senderAddressLine\":\"الفرعي،، الطريق الدائري الجنوبي حي العزيزية،, Riyadh 11564, Saudi Arabia\",\n \"lat\":\"24.7310685013539\",\n \"lon\":\"46.70160835803429\"\n\n },\n \"customer\": {\n \"name\": \"عبدالله الغامدي\",\n \"email\": \"[email protected]\",\n \"mobile\": \"546607389\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"district\": \"Al Hamra\",\n \"city\": \"Riyadh\",\n \"country\": \"SA\",\n \"postcode\": \"12345\",\n \"lat\": \"40.706333\",\n \"lon\": \"29.888211\",\n \"refID\":\"1000012\",\n \"W3WAddress\":\"alarmed.cards.stuffy\"\n },\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product\",\n \"image\": \"http://....\"\n },\n {\n \"name\": \"test product 2\",\n \"price\": 100,\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"image\": \"http://....\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "39ccd2317d3c01a5548073a3ca31383b;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 10:41:22 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "2"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "\r\n{\r\n \"success\":true,\r\n\t\"message\": \"Successfully updated\"\r\n}"
}
]
},
{
"name": "Update Order Status",
"request": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderIds\": [\r\n 30846946\r\n ],\r\n \"status\": \"delivered\",\r\n \"date\": \"2024-08-06T21:00:00.000Z\",\r\n \"description\": \"aaaaaa\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateOrderStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateOrderStatus"]
},
"description": "**Available Packages:** Starter, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to modify the current status of an order within the system. \nYou can update the order status to \"delivered,\" \"returned,\" or \"picked up\" if the order does not have an associated shipment. However, if a shipment exists, only statuses for integrator-managed shipments can be updated.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderIds | yes | string | Id of the order/s |\n| status | yes | string | status of the shipment(delivered, returned, pickedUp) |\n| description | no | string | description of the status change |\n| date | no | date | the delivery date of the order |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImNlMzcxNzMwZWY4NmViYTI5YTUyMTJkOWI5NmYzNjc1NTA0ZjYyYmMiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6Ik5pY2VzdXBlcmFkbWluIiwidXNlcklkIjoiNTUwOSIsImVtYWlsIjoibmljZXN1cGVyYWRtaW5AdHJ5b3RvLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTcyMzAzNTU0MCwidXNlcl9pZCI6InoxaHNpeFJjTjlVQkdsd1ZFbmpTRUlxZkt5ODMiLCJzdWIiOiJ6MWhzaXhSY045VUJHbHdWRW5qU0VJcWZLeTgzIiwiaWF0IjoxNzIzMDM1NTQwLCJleHAiOjE3MjMwMzkxNDAsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJuaWNlc3VwZXJhZG1pbkB0cnlvdG8uY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiY3VzdG9tIn19.mUkzwBrxlisXmFvb_vkaQx2hek2tEyT1FCFitF1KX3AyrRTi3aFEeh7f7MvBgZdK0JxCc2aifXARLV0nGgL2wyutoXnr-sulE8Pe5sc5qb4ENyokaZY7mKJD_gATzRSj3N7lw4G6pcpcAAtcup7nRgxlprY4x1bleNGD2uhpJOjGnHa3XCBoAUA-gYI9iRxL0Xj_s2WSugZp1Qc2e2yxDQzqaj8vLi4UvRJEZuVFJe9zX8IrqPkhJ8dXN4M9KD9t4016mFTuEe8cxdUrK4WObNp1wLbEJbJxov_SJlB7rd4rpC_L1Pzk8Hye6GoJKNQ30OGMczfDS8WX0L_fJrpTKg",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderIds\": [\r\n 30846946\r\n ],\r\n \"status\": \"delivered\",\r\n \"date\": \"2024-08-06T21:00:00.000Z\",\r\n \"description\": \"delivered\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateOrderStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateOrderStatus"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 08 Aug 2024 15:11:12 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "56"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"result\": [\n {},\n {\n \"success\": true,\n \"orderIds\": [\n \"30846946\"\n ]\n }\n ]\n}"
}
]
},
{
"name": "Cancel Order",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelOrder"]
},
"description": "**Available Packages: All Packages**\n\nThis API endpoint allows users to cancel an existing order under specific conditions. It ensures smooth and efficient handling of cancellations while maintaining the integrity of related processes.\n\n**Important Note:** If the order has an associated shipment, it cannot be canceled via this endpoint. Shipment-related restrictions ensure the system prevents conflicts or inconsistencies in ongoing fulfillment processes.\n\n \n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | orderId from which you want to cancel. |"
},
"response": [
{
"name": "Cancel Order",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": true\n}"
}
]
},
{
"name": "Get Orders",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orders?perPage=2&page=2&status=delivered",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "2"
},
{
"key": "page",
"value": "2"
},
{
"key": "minDate",
"value": "2024-01-01",
"disabled": true
},
{
"key": "maxDate",
"value": "2024-02-02",
"disabled": true
},
{
"key": "status",
"value": "delivered"
}
]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint is designed to provide a comprehensive overview of orders in your system. This endpoint returns detailed information about each order, including pickup locations, order IDs, item details, and current statuses. It enables seamless tracking and management of orders, ensuring better visibility and control.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| perPage | no | number | Order count in the response. Max limit 100 |\n| page | no | number | Pagination number. You can iterate this field to get all items. |\n| minDate | no | date | Starting \"Order Creation Date\" of your orders in \"yyyy-mm-dd\" format. |\n| maxDate | no | date | Ending \"Order Creation Date\" of your orders in \"yyyy-mm-dd\" format. |\n| status | no | string | Status of the orders. |"
},
"response": [
{
"name": "200 OK-new",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{test-url}}/rest/v2/orders?perPage=5&page=1&minDate=2024-01-01&maxDate=2024-02-02&status=delivered",
"host": ["{{test-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "5"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-02-02"
},
{
"key": "status",
"value": "delivered"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "2344"
},
{
"key": "Date",
"value": "Tue, 25 Feb 2025 14:24:46 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"perPage\": 5,\n \"totalPage\": 1,\n \"success\": true,\n \"orders\": [\n {\n \"skus\": \"\",\n \"orderId\": \"OID-2476-70000203527-1\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"\",\n \"subTotal\": 0,\n \"totalCount\": 2,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"4563731231\",\n \"drivingDistance\": 0,\n \"originCity\": \"Al Kharj\",\n \"currency\": \"SAR\",\n \"modifiedBy\": \"Demo Niceone\",\n \"customerReturnReason\": \"test\",\n \"id\": \"30824696\",\n \"deliveryDate\": \"2024-02-28 14:44:30\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Unnamed Road 16464, Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 700,\n \"grandTotal\": 700,\n \"totalPage\": 1,\n \"weight\": 0.0001,\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Zeynep Alakuş\",\n \"destinationCity\": \"Al Kharj\",\n \"deliverySlot\": \"\",\n \"district\": \"Al Kharj\",\n \"modifiedDate\": \"2024-09-23 13:04:29\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-02-01 11:19:55\",\n \"items\": [\n {\n \"quantity\": 5,\n \"productId\": 591478,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n },\n {\n \"quantity\": 3,\n \"productId\": 591475,\n \"price\": 100,\n \"name\": \"Black Tayt \",\n \"taxAmount\": 0,\n \"sku\": \"2\"\n }\n ],\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Unnamed Road 16464, Saudi Arabia\",\n \"city\": \"Al Kharj\",\n \"district\": \"Al Kharj\",\n \"name\": \"ZeynepAlakuş\",\n \"mobile\": \"4563731231\",\n \"lon\": 47.5413839,\n \"id\": 1,\n \"state\": \"Riyadh Province\",\n \"lat\": 24.0783327\n }\n },\n {\n \"skus\": \"5\",\n \"orderId\": \"OID-2476-70000203528-2\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"1\",\n \"pickupLocationCode\": \"10\",\n \"subTotal\": 0,\n \"totalCount\": 2,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"4563731231\",\n \"drivingDistance\": 0,\n \"originCity\": \"Al Kharj\",\n \"currency\": \"SAR\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30824710\",\n \"deliveryDate\": \"2024-02-28 14:40:07\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Unnamed Road 16464, Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 80,\n \"grandTotal\": 80,\n \"totalPage\": 1,\n \"weight\": 0.0001,\n \"pickupLocation\": \"DefaultWH\",\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Zeynep Alakuş\",\n \"destinationCity\": \"Al Kharj\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-12-08 16:15:23\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-02-01 11:39:59\",\n \"items\": [\n {\n \"quantity\": 1,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n }\n ],\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Unnamed Road 16464, Saudi Arabia\",\n \"city\": \"Al Kharj\",\n \"name\": \"ZeynepAlakuş\",\n \"mobile\": \"4563731231\",\n \"lon\": 47.5413839,\n \"id\": 1,\n \"lat\": 24.0783327\n }\n }\n ],\n \"currentPage\": 1,\n \"totalCount\": 2\n}"
},
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orders?perPage=3&page=1&minDate=2022-01-01&maxDate=2022-01-10",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "3"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2022-01-01"
},
{
"key": "maxDate",
"value": "2022-01-10"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "52cf90d4035b98974036c6edd4a970b3"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Mon, 21 Feb 2022 07:26:36 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "635"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"orders\": [\n {\n \"pickupLocationCode\": \"EG-ALX\",\n \"id\": 1624606,\n \"pickupLocation\": \"Branch Alexandria EG\",\n \"orderId\": \"202201040915\",\n \"items\": [\n {\n \"sku\": \"test003\",\n \"quantity\": 1\n },\n {\n \"sku\": \"test002\",\n \"quantity\": 2\n }\n ],\n \"status\": \"searchingDriver\"\n },\n {\n \"pickupLocationCode\": \"WMWHSE1\",\n \"id\": 1627155,\n \"pickupLocation\": \"Warehouse RIYADH اختبار\",\n \"orderId\": \"202201040915-C\",\n \"items\": [\n {\n \"sku\": \"test003\",\n \"quantity\": 1\n },\n {\n \"sku\": \"test002\",\n \"quantity\": 2\n }\n ],\n \"status\": \"assignedToWarehouse\"\n },\n {\n \"pickupLocationCode\": \"WMWHSE1\",\n \"id\": 1628829,\n \"pickupLocation\": \"Warehouse RIYADH اختبار\",\n \"orderId\": \"050122001\",\n \"items\": [\n {\n \"sku\": \"002\",\n \"quantity\": 2\n }\n ],\n \"status\": \"pickedUp\"\n }\n ]\n}"
},
{
"name": "400",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orders?perPage=10&page=1&minDate=2022/01/01&maxDate=2022-01-14",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2022/01/01"
},
{
"key": "maxDate",
"value": "2022-01-14"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "7c5f421137c38db22a58ca567b7c6fef"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Mon, 21 Feb 2022 07:31:12 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "63"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1107\",\n \"otoErrorMessage\":\"minDate or maxDate is missing or invalid\"\n}"
},
{
"name": "Get Orders by Pickup Location",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orders?perPage=10&page=1&minDate=2022-01-01&maxDate=2022-01-14&pickupLocationCode=WMWHSE1",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2022-01-01"
},
{
"key": "maxDate",
"value": "2022-01-14"
},
{
"key": "pickupLocationCode",
"value": "WMWHSE1"
}
]
}
},
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "200 OK - multiple statuses",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{test-url}}/rest/v2/orders?perPage=5&page=1&minDate=2024-01-01&maxDate=2025-02-02&status=pickedUp,delivered,branchAssigned",
"host": ["{{test-url}}"],
"path": ["rest", "v2", "orders"],
"query": [
{
"key": "perPage",
"value": "5"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2025-02-02"
},
{
"key": "status",
"value": "pickedUp,delivered,branchAssigned"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "x-content-type-options",
"value": "nosniff"
},
{
"key": "x-xss-protection",
"value": "0"
},
{
"key": "cache-control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "pragma",
"value": "no-cache"
},
{
"key": "expires",
"value": "0"
},
{
"key": "x-frame-options",
"value": "DENY"
},
{
"key": "content-type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "63ab7217aa6c4b7219a2f3da2edb917c;o=1"
},
{
"key": "Date",
"value": "Thu, 13 Mar 2025 11:55:04 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "6696"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
}
],
"cookie": [],
"body": "{\n \"perPage\": 5,\n \"totalPage\": 8,\n \"success\": true,\n \"orders\": [\n {\n \"skus\": \"2, 7, 5\",\n \"orderId\": \"OID-2476-70000203525\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 375,\n \"quantities\": \"2, 2, 1\",\n \"subTotal\": 0,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"4563731231\",\n \"drivingDistance\": 0,\n \"packingStatus\": \"partiallyPicked\",\n \"originCity\": \"Jeddah\",\n \"currency\": \"SAR\",\n \"onHoldReason\": \"The products are out of stock\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30823059\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Jeddah\",\n \"isReturnShipment\": \"no\",\n \"amount\": 370,\n \"grandTotal\": 370,\n \"weight\": 0.0001,\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Zeynep Alakuş\",\n \"destinationCity\": \"Jeddah\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-07-25 08:08:46\",\n \"paymentMethod\": \"cod\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-01-21 13:32:47\",\n \"deliveryName\": \"Safe arrival 5 days\",\n \"items\": [\n {\n \"image\": \"https://cdn.dsmcdn.com/ty173/product/media/images/20210908/15/127661138/239090864/1/1_org_zoom.jpg\",\n \"quantity\": 2,\n \"productId\": 591475,\n \"price\": 100,\n \"name\": \"Black Tayt \",\n \"sku\": \"2\"\n },\n {\n \"image\": \"https://cdn.dsmcdn.com/ty162/product/media/images/20210824/5/121856083/232290387/0/0_org_zoom.jpg\",\n \"quantity\": 2,\n \"productId\": 591480,\n \"price\": 45,\n \"name\": \" Women's Wallets\",\n \"sku\": \"7\"\n },\n {\n \"image\": \"https://admin.alsaifgallery.com/media/catalog/product/_/6/_6_2_6285360068059-2.jpg\",\n \"quantity\": 1,\n \"productId\": 591478,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"sku\": \"5\"\n }\n ],\n \"status\": \"pickedUp\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Jeddah\",\n \"city\": \"Jeddah\",\n \"name\": \"ZeynepAlakuş\",\n \"mobile\": \"4563731231\",\n \"lon\": 39.1610863,\n \"id\": 1,\n \"state\": \"Makkah Province\",\n \"lat\": 21.5291545\n }\n },\n {\n \"skus\": \"\",\n \"orderId\": \"OID-2476-70000203527-1\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"\",\n \"subTotal\": 0,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"4563731231\",\n \"drivingDistance\": 0,\n \"originCity\": \"Al Kharj\",\n \"currency\": \"SAR\",\n \"customerReturnReason\": \"test\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30824696\",\n \"deliveryDate\": \"2024-02-28 14:44:30\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Unnamed Road 16464, Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 700,\n \"grandTotal\": 700,\n \"weight\": 0.0001,\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Zeynep Alakuş\",\n \"destinationCity\": \"Al Kharj\",\n \"district\": \"Al Kharj\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-09-23 13:04:29\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-02-01 11:19:55\",\n \"deliveryName\": \"Safe arrival 5 days\",\n \"items\": [\n {\n \"quantity\": 5,\n \"productId\": 591478,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n },\n {\n \"quantity\": 3,\n \"productId\": 591475,\n \"price\": 100,\n \"name\": \"Black Tayt \",\n \"taxAmount\": 0,\n \"sku\": \"2\"\n }\n ],\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Unnamed Road 16464, Saudi Arabia\",\n \"city\": \"Al Kharj\",\n \"district\": \"Al Kharj\",\n \"name\": \"ZeynepAlakuş\",\n \"mobile\": \"4563731231\",\n \"lon\": 47.5413839,\n \"id\": 1,\n \"state\": \"Riyadh Province\",\n \"lat\": 24.0783327\n }\n },\n {\n \"skus\": \"5\",\n \"orderId\": \"OID-2476-70000203528-2\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"1\",\n \"pickupLocationCode\": \"10\",\n \"subTotal\": 0,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"4563731231\",\n \"drivingDistance\": 0,\n \"originCity\": \"Al Kharj\",\n \"currency\": \"SAR\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30824710\",\n \"deliveryDate\": \"2024-02-28 14:40:07\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Unnamed Road 16464, Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 80,\n \"grandTotal\": 80,\n \"weight\": 0.0001,\n \"pickupLocation\": \"DefaultWH\",\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Zeynep Alakuş\",\n \"destinationCity\": \"Al Kharj\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-12-08 16:15:23\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-02-01 11:39:59\",\n \"deliveryName\": \"Safe arrival 5 days\",\n \"items\": [\n {\n \"quantity\": 1,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n }\n ],\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Unnamed Road 16464, Saudi Arabia\",\n \"city\": \"Al Kharj\",\n \"name\": \"ZeynepAlakuş\",\n \"mobile\": \"4563731231\",\n \"lon\": 47.5413839,\n \"id\": 1,\n \"lat\": 24.0783327\n }\n },\n {\n \"skus\": \"6, 5, 7, 500, asdasda\",\n \"orderId\": \"OID-2476-70000203558\",\n \"trackingURL\": \"https://app.tryoto.com/otoflex-tracking?enc=RFFTeDdjS1MzWGk2d2krZlc4cnllWXdDQkhPOVh1QWhQMzFUbmo4L2k4V01DZGJ3V0Z2L2d3PT0=\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"1, 1, 1, 1, 1\",\n \"subTotal\": 0,\n \"addressConfirm\": \"notYet\",\n \"shipmentCreationDate\": \"2024-07-17 09:22:56\",\n \"customerPhone\": \"966544517086\",\n \"drivingDistance\": 0,\n \"originCity\": \"Jeddah\",\n \"currency\": \"SAR\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30844197\",\n \"shipmentNumber\": \"53cab60e\",\n \"customerAddress\": \"F5PV+82C, Al-Suhaifah, Jeddah 22237, Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 200,\n \"grandTotal\": 200,\n \"weight\": 0.0001,\n \"pickupLocation\": \"BranchEx\",\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Ezz \",\n \"destinationCity\": \"Jeddah\",\n \"district\": \"Al-Suhaifah\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-08-18 12:45:29\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-07-17 09:22:46\",\n \"deliveryName\": \"oto flex\",\n \"items\": [\n {\n \"quantity\": 1,\n \"productId\": 591479,\n \"price\": 1000,\n \"name\": \"Apple Macbook Air 13'' M1\",\n \"taxAmount\": 0,\n \"sku\": \"6\"\n },\n {\n \"quantity\": 1,\n \"productId\": 591478,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n },\n {\n \"quantity\": 1,\n \"productId\": 591480,\n \"price\": 45,\n \"name\": \" Women's Wallets\",\n \"taxAmount\": 0,\n \"sku\": \"7\"\n },\n {\n \"quantity\": 1,\n \"productId\": 6200329,\n \"price\": 200,\n \"name\": \"ErenTest2\",\n \"taxAmount\": 0,\n \"sku\": \"500\"\n },\n {\n \"quantity\": 1,\n \"productId\": 6083509,\n \"price\": 123,\n \"name\": \"ErenTest\",\n \"taxAmount\": 123,\n \"sku\": \"asdasda\"\n }\n ],\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"F5PV+82C, Al-Suhaifah, Jeddah 22237, Saudi Arabia\",\n \"city\": \"Jeddah\",\n \"district\": \"Al-Suhaifah\",\n \"name\": \"Ezz\",\n \"postcode\": \"22237\",\n \"mobile\": \"966544517086\",\n \"lon\": 39.1925062,\n \"id\": 1,\n \"state\": \"Makkah Province\",\n \"lat\": 21.4858187\n }\n },\n {\n \"skus\": \"7, 5\",\n \"orderId\": \"OID-2476-70000203557-2\",\n \"trackingURL\": \"\",\n \"reverseShipment\": \"false\",\n \"totalDue\": 0,\n \"quantities\": \"1, 1\",\n \"pickupLocationCode\": \"222\",\n \"subTotal\": 0,\n \"addressConfirm\": \"notYet\",\n \"customerPhone\": \"962796699066\",\n \"drivingDistance\": 0,\n \"packingStatus\": \"picked\",\n \"originCity\": \"Jeddah\",\n \"currency\": \"SAR\",\n \"modifiedBy\": \"Demo Niceone\",\n \"id\": \"30845010\",\n \"shipmentNumber\": \"\",\n \"customerAddress\": \"Jeddah Saudi Arabia\",\n \"isReturnShipment\": \"no\",\n \"amount\": 125,\n \"grandTotal\": 125,\n \"weight\": 0.0001,\n \"pickupLocation\": \"WH-5\",\n \"destinationCountry\": \"SA\",\n \"customerName\": \"Ezz sss\",\n \"destinationCity\": \"Jeddah\",\n \"deliverySlot\": \"\",\n \"modifiedDate\": \"2024-07-25 08:46:15\",\n \"paymentMethod\": \"paid\",\n \"packageCount\": 1,\n \"orderDate\": \"2024-07-23 06:34:57\",\n \"deliveryName\": \"Safe arrival 5 days\",\n \"items\": [\n {\n \"quantity\": 1,\n \"productId\": 591480,\n \"price\": 45,\n \"name\": \" Women's Wallets\",\n \"taxAmount\": 0,\n \"sku\": \"7\"\n },\n {\n \"quantity\": 1,\n \"productId\": 591478,\n \"price\": 80,\n \"name\": \"Raincoat\",\n \"taxAmount\": 0,\n \"sku\": \"5\"\n }\n ],\n \"status\": \"pickedUp\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"Jeddah Saudi Arabia\",\n \"city\": \"Jeddah\",\n \"name\": \"Ezzsss\",\n \"mobile\": \"962796699066\",\n \"lon\": 39.192505,\n \"id\": 1,\n \"lat\": 21.485811\n }\n }\n ],\n \"currentPage\": 1,\n \"totalCount\": 40\n}"
}
]
},
{
"name": "Get Order Details",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orderDetails",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderDetails"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint provides detailed information about a specific order. By using this endpoint, you can retrieve comprehensive data about an order including status updates.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the Order |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/orderDetails",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "orderDetails"],
"query": [
{
"key": "perPage",
"value": "10",
"disabled": true
},
{
"key": "page",
"value": "1",
"disabled": true
},
{
"key": "minDate",
"value": "2021-01-01",
"disabled": true
},
{
"key": "maxDate",
"value": "2022-06-14",
"disabled": true
},
{
"key": "id",
"value": "3077121",
"disabled": true
},
{
"key": "orderId",
"value": "flex80043",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "1a50328f024a40a5a98755e0b9af6f93;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 17 Nov 2022 09:05:51 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "1427"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Access-Control-Allow-Methods",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "*"
}
],
"cookie": [],
"body": "{\n \"orderId\": \"flex80043\",\n \"trackingURL\": \"https://login.tryoto.com/main/otoFlexTracking?enc=U2FEaTJIcUZrcDhCVk1OYStUVTlIOGYzZHlTNXg4aUw=\",\n \"packageWeight\": 1,\n \"deliverySlotFrom\": \"2:30pm\",\n \"dcName\": \"OTO Flex\",\n \"amount_due\": 0,\n \"currency\": \"SAR\",\n \"id\": 3077400,\n \"payment_method\": \"paid\",\n \"deliverySlotTo\": \"12pm\",\n \"amount\": 100,\n \"customsValue\": 12,\n \"pickupLocation\": \"Staging Warehouse\",\n \"deliveryOptionId\": 1609,\n \"statusHistory\": [\n {\n \"date\": \"2022-11-15T07:09:52\",\n \"status\": \"assignedToWarehouse\"\n },\n {\n \"date\": \"2022-11-15T07:09:52\",\n \"description\": \"\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"searchingDriver\"\n },\n {\n \"date\": \"2022-11-16T00:30:24\",\n \"description\": \"Order accepted by Ali Zeynelabidin UZAR phone: 5427107399\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"shipmentCreated\"\n },\n {\n \"date\": \"2022-11-16T00:30:34\",\n \"description\": \"Order goingToPickup by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"goingToPickup\"\n },\n {\n \"date\": \"2022-11-16T00:32:08\",\n \"description\": \"Order pickedUp by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"pickedUp\"\n }\n ],\n \"deliverySlotDate\": \"2020-12-31T00:00\",\n \"success\": true,\n \"customsCurrency\": \"USD\",\n \"name\": \" \",\n \"packageCount\": 2,\n \"orderDate\": \"2022-11-15 07:09:52\",\n \"items\": [\n {\n \"quantity\": 1,\n \"rowTotal\": 100,\n \"sku\": \"test-product\",\n \"taxAmount\": 15,\n \"price\": 100\n },\n {\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"price\": 100\n }\n ],\n \"status\": \"pickedUp\"\n}"
},
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/orderDetails",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderDetails"],
"query": [
{
"key": "perPage",
"value": "10",
"disabled": true
},
{
"key": "page",
"value": "1",
"disabled": true
},
{
"key": "minDate",
"value": "2021-01-01",
"disabled": true
},
{
"key": "maxDate",
"value": "2022-06-14",
"disabled": true
},
{
"key": "id",
"value": "3077121",
"disabled": true
},
{
"key": "orderId",
"value": "flex80043",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "a5aec0c9ff97fda3179097ae1021c86e;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 20 Nov 2022 09:02:17 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "2097"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Access-Control-Allow-Methods",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "*"
}
],
"cookie": [],
"body": "{\n \"deliverySlotTo\": \"12pm\",\n \"amount\": 100,\n \"orderId\": \"flex80043\",\n \"trackingURL\": \"https://login.tryoto.com/main/otoFlexTracking?enc=U2FEaTJIcUZrcDhCVk1OYStUVTlIOGYzZHlTNXg4aUw=\",\n \"packageWeight\": 1,\n \"customsValue\": 12,\n \"deliverySlotFrom\": \"2:30pm\",\n \"pickupLocation\": \"Staging Warehouse\",\n \"deliveryOptionId\": 1609,\n \"statusHistory\": [\n {\n \"date\": \"2022-11-15T07:09:52\",\n \"status\": \"assignedToWarehouse\"\n },\n {\n \"date\": \"2022-11-15T07:09:52\",\n \"description\": \"\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"searchingDriver\"\n },\n {\n \"date\": \"2022-11-16T00:30:24\",\n \"description\": \"Order accepted by Ali Zeynelabidin UZAR phone: 5427107399\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"shipmentCreated\"\n },\n {\n \"date\": \"2022-11-16T00:30:34\",\n \"description\": \"Order goingToPickup by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"goingToPickup\"\n },\n {\n \"date\": \"2022-11-16T00:32:08\",\n \"description\": \"Order pickedUp by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"pickedUp\"\n },\n {\n \"date\": \"2022-11-17T20:07:55\",\n \"description\": \"Order outForDelivery by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"outForDelivery\"\n },\n {\n \"date\": \"2022-11-18T14:22:34\",\n \"description\": \"Order delivered by Ali Zeynelabidin UZAR\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"shipmentId\": \"6ee37bc6\",\n \"status\": \"delivered\"\n }\n ],\n \"deliverySlotDate\": \"2020-12-31T00:00\",\n \"dcName\": \"OTO Flex\",\n \"success\": true,\n \"customsCurrency\": \"USD\",\n \"amount_due\": 0,\n \"currency\": \"SAR\",\n \"id\": 3077400,\n \"packageCount\": 2,\n \"orderDate\": \"2022-11-15 07:09:52\",\n \"items\": [\n {\n \"quantity\": 1,\n \"rowTotal\": 100,\n \"sku\": \"test-product\",\n \"taxAmount\": 15,\n \"price\": 100\n },\n {\n \"quantity\": 1,\n \"sku\": \"test-product-2\",\n \"price\": 100\n }\n ],\n \"payment_method\": \"paid\",\n \"status\": \"delivered\",\n \"customer\": {\n \"country\": \"SA\",\n \"address\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"city\": \"Jeddah\",\n \"street\": \"6832, Abruq AR Rughamah District, Jeddah 22272 3330, Saudi Arabia\",\n \"name\": \"Sammy Hudson\",\n \"mobile\": \"891-981-0352\",\n \"postcode\": \"12345\",\n \"lon\": 46.724728,\n \"region\": \"Al Hamra\",\n \"email\": \"[email protected]\",\n \"lat\": 24.736599\n }\n}"
}
]
},
{
"name": "Hold Order",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-20980-1146\",\r\n \"onHoldReason\": \"Fraud\",\r\n \"onHoldReasonLang\" : \"en\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/holdOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "holdOrder"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to place an order on hold, temporarily pausing its processing. This is useful for scenarios such as payment verification, inventory issues, or customer requests.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order that you will place on hold. |\n| onHoldReason | yes | string | Reason for being an order on hold. |\n| onHoldReasonLang | yes | string | Values can be: eng, tr, ar. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Berare {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-1002\",\r\n \"onHoldReason\": \"Damaged\",\r\n \"onHoldReasonLang\" : \"en\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/holdOrder",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "holdOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "69415d98a3a3e7623ff9a7efb3d4b9ad;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 14 Jul 2024 10:51:24 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "0"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\r\n \"success\": true\r\n}"
},
{
"name": "400 missing reason config lang",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Berare {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-1002\",\r\n \"onHoldReason\": \"qafasd\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/holdOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "holdOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "073a89b2904476e504318424fdb6f7ac"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 14 Jul 2024 10:51:43 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "73"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO110\",\n \"otoErrorMessage\":\"On Hold reason is is missing or invalid\"\n}"
},
{
"name": "400 missing reason config",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Berare {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-1002\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/holdOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "holdOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "04cfa15b92a1d97f03a4ab8a34b596bc;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 14 Jul 2024 10:51:55 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "69"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO110\",\n \"otoErrorMessage\":\"On Hold reason is is missing or invalid\"\n}"
}
]
},
{
"name": "Unhold Order",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-98794\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/unHoldOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "unHoldOrder"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows users to release orders that are currently on hold. This endpoint is designed to resume the processing of held orders, making them available for fulfillment or further actions in the order management workflow.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | The orderId you want to unhold. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Berare {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-98794\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/unHoldOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "unHoldOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "32dd74b85236114a7b97020ba6c3b061"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 14 Jul 2024 11:00:42 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "16"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true\n}"
},
{
"name": "400 not allowed status",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Berare {{oto-token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-98794\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/unHoldOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "unHoldOrder"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "b336dcfefa3e0b27e62fb7f46748a926;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 14 Jul 2024 10:53:35 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "96"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1103\",\n \"otoErrorMessage\":\"Status of the order is not suitable for the action\"\n}"
}
]
}
]
},
{
"name": "Shipments",
"item": [
{
"name": "Create Shipment",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1232464\",\r\n \"deliveryOptionId\":\"12345\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you create shipment for orders, while creating shipments need a valid delivery option id. You can get valid delivery options in two ways:\n\n- **Delivery Options with OTO rates**: \n No contracted delivery companies or activation is required. OTO offers a range of delivery company options, which are available for use. You can view these options and their associated fees by using the `Check OTO Delivery Fee` endpoint.\n \n- **Delivery Options with your own rates:** \n In this case, you already have agreements with one or more delivery companies. Each delivery company you connect is linked to a specific delivery option ID. You can retrieve these IDs by using the `Get Delivery Options` or `checkDeliveryFee` endpoints.\n \n\n**Note:** If deliveryOptionId is not sent on the request, the assignment is made to the delivery company that complies with your feasibility rule. If you do not have a feasibility rule setting, the order will be automatically assigned to the first delivery company added.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | Order number for which you want to create a shipment |\n| deliveryOptionId | no | int | Activated delivery company option id |\n| pickingType | no | enum | Possible values: <br>PICKUP_BY_DC: Shipping company offers free pickup from origin. BRANCH_DROP_OFF: Package must be delivered to a branch of the shipping company. |\n| whoPays | no | enum | If implemented, annotates who wil pay for the shipment. Possible values: marketplacePaysDeliveryFee, sellerPaysDeliveryFee |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1232464\",\r\n \"deliveryOptionId\":\"12345\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"create shipment request is received.\"\n}"
},
{
"name": "200 with whoPays",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1232464\",\r\n \"deliveryOptionId\":\"12345\",\r\n \"whoPays\": \"marketplacePaysDeliveryFee\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"create shipment request is received.\"\n}"
},
{
"name": "404",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1232464\",\r\n \"deliveryOptionId\":\"12345\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1002\",\n \"otoErrorMessage\":\"Order is not exist\"\n}"
},
{
"name": "400 - credit",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1232464\",\r\n \"deliveryOptionId\":\"12345\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1006\",\n \"otoErrorMessage\":\"Credit is not enough\"\n}"
},
{
"name": "400 - orderId required",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"\",\r\n \"deliveryOptionId\":\"12345\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1001\",\n \"otoErrorMessage\":\"Invalid or missing order Id\"\n}"
}
]
},
{
"name": "Cancel Shipment",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"24543ec5-1dd2-46a1-b4b3-d3bd47837665\",\r\n \"shipmentId\": \"F21SACO00227700000\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelShipment"]
},
"description": "**Available Packages**: All Packages\n\nThis API initiates the cancellation process with the shipping company.\n\n- Shipments cannot be canceled once they have reached the \"**picked up**\" status.\n \n- Some shipping companies do not support shipment cancellations, which may result in a failure response indicating the shipment could not be canceled.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | orderId from which shipment was created |\n| shipmentId | yes | string | Shipment id to be cancelled. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"fc800616-bf12-4cd0-b456-183ae2680b1b\",\r\n \"shipmentId\": \"44116718461\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "85608d62696e5ef545d0f9c459c082d1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 22 Jan 2023 13:18:21 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "16"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true\n}"
},
{
"name": "400",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"fc800616-bf12-4cd0-b456-183ae2680b1b\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "3bffd7092531ee3dd6b870b7377eb586"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 22 Jan 2023 13:18:42 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "67"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1079\",\n \"otoErrorMessage\":\"Shipment id is required\"\n}"
},
{
"name": "400",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"fc800616-bf12-4cd0-b456-183ae2680b1b\",\r\n \"shipmentId\": \"44116718461000\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/cancelShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "cancelShipment"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "1fa64e540d134392bd3301c45950e16c"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 22 Jan 2023 13:18:57 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "106"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1082\",\n \"otoErrorMessage\":\"Order Status is not allowed for cancel shipment\"\n}"
}
]
},
{
"name": "Shipment Transactions",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/shipmentTransactions?perPage=10&page=1&minDate=2024-01-01&maxDate=2024-09-14",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "shipmentTransactions"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-09-14"
}
]
},
"description": "### Shipment Transactions\n\n**Available Packages:** All Packages\n\nThis API endpoint provides users with access to detailed information about shipment transactions. This API is designed to retrieve and display key transaction data, allowing users to monitor and review shipment-related activities.It retrieves shipment transactions with the option to paginate and filter by minimum and maximum dates.\n\n**Note:**\n\nIf orderId exists maxDate and minDate are not required.\n\nIf shipment number exists maxDate and minDate are not required.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| perPage | no | number | The number of transactions to be included per page. |\n| page | no | number | The page number for paginated results. |\n| minDate | yes (If there is no orderId) | date | Starting \"Transaction Date\" of your credit transactions in \"yyyy-mm-dd\" format. |\n| maxDate | yes (If there is no orderId) | date | Ending \"Transaction Date\" of your credit transactions in \"yyyy-mm-dd\" format. |\n| orderId | no | string | Order ID for transactions of a single Order |\n| shipmentNumber | no | string | Shipment Number for transactions of a single shipment |\n\n#### Response Body\n\nThe response will include a `success` flag indicating the status of the request, and an `shipments` array containing transaction details. Each transaction object in the `shipments` array includes the following properties:\n\n``` json\n{\n \"success\": true,\n \"shipments\": [\n {\n \"shipmentNumnber\": \"1231231AS\",\n \"orderId\": \"123123\",\n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 25,\n \"currency\": \"TRY\",\n \"originalWeight\": 100,\n \"dcUpdatedWeight\": 50,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 15579456\n }\n\n ```"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/shipmentTransactions?perPage=10&page=1&minDate=2024-01-01&maxDate=2024-09-14",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "shipmentTransactions"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-09-14"
},
{
"key": "orderId",
"value": "123123",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "ed83d57ca47db187364d7420e8a2c5f0"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:11:47 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "32"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"shipments\": [\n {\n \"shipmentNumber\": \"1231231AS\", \n \"orderId\": \"123123\", \n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 25,\n \"currency\": \"TRY\",\n \"originalWeight\": 100,\n \"dcUpdatedWeight\": 50,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 15579456\n },\n {\n \"shipmentNumber\": \"12435356\",\n \"orderId\": \"342324234\",\n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 40,\n \"currency\": \"TRY\",\n \"originalWeight\": 40,\n \"dcUpdatedWeight\": 5,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 21626353729823\n },\n {\n \"shipmentNumber\": \"657567\",\n \"orderId\": \"34534534\",\n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 60,\n \"currency\": \"TRY\",\n \"originalWeight\": 80,\n \"dcUpdatedWeight\": 80,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 21626353729823123213\n },\n {\n \"shipmentNumber\": \"5423423\",\n \"orderId\": \"14335213\",\n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 25,\n \"currency\": \"TRY\",\n \"originalWeight\": 100,\n \"dcUpdatedWeight\": 50,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 2162635372\n }\n ]\n}"
},
{
"name": "200 empty result",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/shipmentTransactions?perPage=10&page=1&minDate=2024-01-01&maxDate=2024-09-14",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "shipmentTransactions"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-09-14"
},
{
"key": "orderId",
"value": "123123",
"disabled": true
},
{
"key": "shipmentNumber",
"value": "1231231AS",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "ed83d57ca47db187364d7420e8a2c5f0"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:11:47 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "32"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"shipments\": []\n}"
},
{
"name": "200 with order informatoin",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/shipmentTransactions?perPage=10&page=1&minDate=2024-01-01&maxDate=2024-09-14&orderId=123123&shipmentNumber=1231231AS",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "shipmentTransactions"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-09-14"
},
{
"key": "orderId",
"value": "123123"
},
{
"key": "shipmentNumber",
"value": "1231231AS"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "ed83d57ca47db187364d7420e8a2c5f0"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:11:47 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "32"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"shipments\": [\n {\n \"shipmentNumber\": \"1231231AS\",\n \"orderId\": \"123123\",\n \"shipmentCreationDate\": \"2023-12-05T06:47:46\",\n \"deliveryCompanyName\": \"deliveryCompany\",\n \"dcConnectionName\": \"connectionName\",\n \"shipmentType\": \"Forward Shipment\",\n \"dcCharge\": 25,\n \"currency\": \"TRY\",\n \"originalWeight\": 100,\n \"dcUpdatedWeight\": 50,\n \"status\": \"status\",\n \"dcInvoiceNumber\": 21626353729823954\n }\n ]\n}"
},
{
"name": "400",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/shipmentTransactions?perPage=10&page=1&minDate=2024-01-01&maxDate=2024-09-14&orderId=123&shipmentNumber=1231231AS",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "shipmentTransactions"],
"query": [
{
"key": "perPage",
"value": "10"
},
{
"key": "page",
"value": "1"
},
{
"key": "minDate",
"value": "2024-01-01"
},
{
"key": "maxDate",
"value": "2024-09-14"
},
{
"key": "orderId",
"value": "123"
},
{
"key": "shipmentNumber",
"value": "1231231AS"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "ed83d57ca47db187364d7420e8a2c5f0"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:11:47 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "32"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1002\",\n \"otoErrorMessage\":\"Order is not exist\"\n}"
}
]
},
{
"name": "Get Shipping Price Transactions List",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"shipmentId\": \"2302416029\",\r\n \"orderId\": \"OID-22700-1013\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getShippingPriceTransactionsList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getShippingPriceTransactionsList"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides details of your Shipping Price Transactions, calculated based on your configured shipping price settings. By providing either the Order ID or Shipment ID, you can retrieve the shipping cost along with other transactional details.\n\n**Important Note:** \nThe results from this API apply only to shipments created using your configured shipping price contracts. Shipping costs are calculated based on factors such as weight, destination, and other predefined configurations.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order. |\n| shipmentId | yes | string | The shipment ID to retrieve shipping cost details. |"
},
"response": [
{
"name": "200 Order ID and Shipmetn ID request example",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"shipmentId\": \"290399219480\",\r\n \"orderId\": \"OID-9618-1062\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getShippingPriceTransactionsList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getShippingPriceTransactionsList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "0f93a46645e019c12b559f306101a1f7;o=1"
},
{
"key": "Date",
"value": "Mon, 11 Dec 2023 10:39:39 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "326"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"count\": 1,\n \"shippingTransactions\": [\n {\n \"amount\": 11,\n \"orderID\": \"OID-9618-1062\",\n \"shipmentID\": \"290615409716\",\n \"description\": \"shipment created\",\n \"orderStatus\": \"shipmentCreated\",\n \"ID\": 1347,\n \"transactionDate\": \"2023-12-06T16:18\",\n \"otoOrderID\": 30798075,\n \"deliveryName\": \"smsav2-2\",\n \"transaction\": \"shippingCost\",\n \"status\": \"booked\"\n }\n ]\n}"
},
{
"name": "200 Order ID request example",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9618-1062\"\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getShippingPriceTransactionsList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getShippingPriceTransactionsList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "e726dd2868e8c6f1fb0fbd22676450cd;o=1"
},
{
"key": "Date",
"value": "Mon, 11 Dec 2023 12:54:35 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "326"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"count\": 1,\n \"shippingTransactions\": [\n {\n \"amount\": 11,\n \"orderID\": \"OID-9618-1062\",\n \"shipmentID\": \"290615409716\",\n \"description\": \"shipment created\",\n \"orderStatus\": \"shipmentCreated\",\n \"ID\": 1347,\n \"transactionDate\": \"2023-12-06T16:18\",\n \"otoOrderID\": 30798075,\n \"deliveryName\": \"smsav2-2\",\n \"transaction\": \"shippingCost\",\n \"status\": \"booked\"\n }\n ]\n}"
},
{
"name": "200 Shipment ID request example",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"shipmentId\": \"290615403740\"\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getShippingPriceTransactionsList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getShippingPriceTransactionsList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "3b86b849a1fed0b6dcf23cafa07aff22;o=1"
},
{
"key": "Date",
"value": "Mon, 11 Dec 2023 12:57:51 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "329"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"count\": 1,\n \"shippingTransactions\": [\n {\n \"amount\": 11,\n \"orderID\": \"OID-9618-1059\",\n \"shipmentID\": \"290615403740\",\n \"description\": \"shipment created\",\n \"orderStatus\": \"shipmentCreated\",\n \"ID\": 1340,\n \"transactionDate\": \"2023-12-06T15:56:26\",\n \"otoOrderID\": 30798062,\n \"deliveryName\": \"smsav2-2\",\n \"transaction\": \"shippingCost\",\n \"status\": \"booked\"\n }\n ]\n}"
}
]
}
]
},
{
"name": "Return Shipments",
"item": [
{
"name": "Create Return Shipment",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [""],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [""],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"202111080914\",\n \"deliveryOptionId\": \"156\",\n \"pickupLocationCode\": \"wh1\",\n \"items\": [\n {\n \"quantity\": \"1\",\n \"sku\": \"SKU045857\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createReturnShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createReturnShipment"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you create reverse shipment for delivered orders, while creating shipments need a valid delivery option id. You can get valid delivery options in two ways:\n\n- **Delivery Options with OTO rates**: \n No contracted delivery companies or activation is required. OTO offers a range of delivery company options, which are available for use. You can view these options and their associated fees by using the `Check OTO Delivery Fee` endpoint.\n \n- **Delivery Options with your own rates:** \n In this case, you already have agreements with one or more delivery companies. Each delivery company you connect is linked to a specific delivery option ID. You can retrieve these IDs by using the `Get Delivery Options` or `checkDeliveryFee` endpoints.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | Order number for which you want to create a reverse shipment. |\n| pickupLocationCode | no | string | Predefined pickup address of branches/warehouses from `Create Pickup Location` endpoint. |\n| deliveryOptionId | yes | string | Activated delivery company option id. |\n| pickingType | | enum | Possible values: <br>PICKUP_BY_DC: Shipping company offers free pickup from origin. BRANCH_DROP_OFF: Package must be delivered to a branch of the shipping company. |\n| items | no | Array | Array of items. |\n\n###### Item fields definitions:\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| quantity | yes | string | Return quantity of item. |\n| sku | yes | string | Sku of return item. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderId\": \"202111080914\",\n \"deliveryOptionId\": \"156\",\n \"pickupLocationCode\": \"wh1\",\n \"items\": [\n {\n \"quantity\": \"1\",\n \"sku\": \"SKU045857\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createReturnShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createReturnShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\r\n \"msg\": \"Return shipment request is received\",\r\n \"success\": true\r\n}"
}
]
},
{
"name": "Get Return Link",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnLink",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnLink"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint generates a link that serves as a return request portal for end customers. The portal allows customers to initiate return requests seamlessly. Additionally, the portal's details and settings can be customized in the OTO Dashboard to align with your specific requirements.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | The order for which a return request is requested. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"1232464\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/getReturnLink",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "getReturnLink"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "305f9067f6a75ceb7737673e299a615c;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Wed, 03 Nov 2021 14:34:59 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "114"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"returnLink\": \"https://app.tryoto.com/sms/return-request?key=Y3RnL0MwMTJiTFYwOVo5UnhGS0lOcU0xcnhBclRVMGwzTENGcjd4bEZCST0=\"\n}"
},
{
"name": "404",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnLink",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnLink"]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": false,\r\n \"otoErrorCode\":\"OTO1002\",\r\n \"otoErrorMessage\":\"Order is not exist\"\r\n}"
},
{
"name": "400",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnLink",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnLink"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": false,\r\n \"otoErrorCode\":\"OTO1001\",\r\n \"otoErrorMessage\":\"Invalid or missing order Id\"\r\n}"
}
]
},
{
"name": "Get Return Details",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-1008\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnDetails",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnDetails"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to retrieve detailed information about the reverse shipment associated with a specific order. Reverse shipments are typically created when an order is returned or exchanged. This endpoint provides comprehensive insights into the reverse shipment process, including: return reason, returned items etc.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Returned order id. |\n\nGlobal error codes are defined in the APPENDIX folder. These are the endpoint specific error codes."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-9616-1008\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnDetails",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnDetails"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "4750d8956c29ab0ba5e57195e04c059f;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 21 Dec 2023 10:47:00 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "148"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"returnLocationCode\": \"Riyadh\",\n \"orderId\": \"OID-9616-1008\",\n \"returnReason\": \"Damaged\",\n \"items\": [\n {\n \"sku\": \"123456\",\n \"quantityOrdered\": 1\n }\n ],\n \"status\": \"returned\"\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getReturnDetails",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getReturnDetails"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
}
]
},
{
"name": "Trigger Return SMS",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"523939\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/triggerReturnSms",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "triggerReturnSms"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint will trigger an SMS for a successful return request, If your SMS settings are configured correctly.\n\nPlease note that, since the SMS service operates asynchronously, the response does not confirm that the SMS has been delivered to the end customer. For a more detailed investigation of any SMS delivery issues, we recommend checking the **SMS Logs** under the **Logs** section in the OTO UI.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | The orderId you want to trigger return sms. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"flex80055\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/triggerReturnSms",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "triggerReturnSms"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "ed83d57ca47db187364d7420e8a2c5f0"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:11:47 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "32"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 3077435\n}"
},
{
"name": "400",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/triggerReturnSms",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "triggerReturnSms"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "db3d2adec7fb9a4e689a6140c1d363e0;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 19 Jan 2023 15:10:12 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "61"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Method",
"value": "*"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1002\",\n \"otoErrorMessage\":\"Order is not exist\"\n}"
}
]
}
]
},
{
"name": "Shipping Label(AWB)",
"item": [
{
"name": "Print AWB",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/print/:orderId",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "print", ":orderId"],
"variable": [
{
"key": "orderId"
}
]
},
"description": "**Available Packages:** All Packages\n\nThis API endpointallows you to access print URL for generated Air Waybill (AWB) for shipments. An AWB is a crucial document used in air delivery transport that contains essential shipping information.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Order id of the order to be printed |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/print/OID-9616-1015",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "print", "OID-9616-1015"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "fb74f443b855e895a6bb29cb15d9014e"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 21 Dec 2023 10:22:50 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "207"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"printAWBURL\": \"https://app.tryoto.com/OTOAWB?enc=eyJpZHMiOlsxMjU1MDkzOF0sImNvbXBhbnlJZCI6MTQ5MjF9\",\n \"deliveryCompany\": \"otoDriverApp\",\n \"trackingNumber\": \"fabda637\"\n}"
}
]
}
]
},
{
"name": "Tracking",
"item": [
{
"name": "Order Tracking",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/orderStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderStatus"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint enables you to track the real-time status and progress of an order. By using this endpoint, you can retrieve detailed tracking information, including:\n\n- Current order status (e.g.,pickedUp, outForDelivery, delivered).\n \n- Shipment details such as carrier, tracking number, and estimated delivery time, print AWB URL.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order that you will track. |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/orderStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderStatus"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 14:51:27 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "text/html;charset=utf-8"
},
{
"key": "Content-Language",
"value": "en"
},
{
"key": "Content-Length",
"value": "1122"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\n \"orderId\": \"1234\",\n \"status\": \"pickedUp\",\n \"deliveryCompany\": \"fastExpress\",\n \"shipmentId\": \"92358235823\",\n \"dcTrackingNumber\":\"983643812\",\n \"date\": \"30/12/2020 14:31:21\",\n \"note\": \"optional note to show in order history\",\n \"deliverySlotDate\": \"30/12/2020\",\n \"printAWBURL\": \"https://app.tryoto.com/OTOAWB?enc=eyJpZHMiOlsxMjU1MDkzOF0sImNvbXBhbnlJZCI6MTQ5MjF9\"\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"1234\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/orderStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderStatus"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
}
]
},
{
"name": "Order History",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderIds\": [\"2414124\",\"3223523\"]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/orderHistory",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderHistory"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to retrieve the complete history of an order, providing detailed insights into its lifecycle. This includes:\n\n- Status changes (e.g., pickedUp, arrivedTerminal, delivered).\n \n- Timestamps for each status update.\n \n- Actions taken during the order process, such as cancellations or modifications.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order that you will track. |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderIds\": [\"2414124\",\"3223523\"]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/orderHistory",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "orderHistory"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 05 Nov 2020 14:54:08 GMT"
},
{
"key": "Server",
"value": "Apache/2.4.29 (Ubuntu)"
},
{
"key": "Content-Type",
"value": "text/html;charset=utf-8"
},
{
"key": "Content-Language",
"value": "en"
},
{
"key": "Content-Length",
"value": "1123"
},
{
"key": "Keep-Alive",
"value": "timeout=5, max=100"
},
{
"key": "Connection",
"value": "Keep-Alive"
}
],
"cookie": [],
"body": "{\r\n \"success\":true,\r\n \"items\": [\r\n {\r\n \"orderId\": \"2414124\",\r\n \"branchName\": \"Olaya branch\",\r\n \"warehouseName\": null,\r\n \"deliveryCompany\": \"fastExpress\",\r\n \"shipmentId\": \"92358235823\",\r\n \"dcTrackingNumber\":\"983643812\",\r\n \"status\": \"delivered\",\r\n \"driverName\": \"Mahmood\",\r\n \"driverPhone\": \"0520213123\",\r\n \"trackingUrl\": \"https://www.aramex.com/sa/ar/track/results?mode=0&ShipmentNumber=44116160255\",\r\n \"history\": [\r\n {\r\n \"date\": \"14/07/2020 09:42:01\",\r\n \"status\": \"branchAssigned\",\r\n \"description\": \"Branch assigned to Olaya branch\",\r\n \"deliveryCompany\": null,\r\n \"shipmentId\": null\r\n },\r\n {\r\n \"date\": \"14/07/2020 12:42:01\",\r\n \"status\": \"shipmentCreated\",\r\n \"description\": \"\",\r\n \"deliveryCompany\": \"fastExpress\",\r\n \"shipmentId\": \"92358235823\"\r\n },\r\n {\r\n \"date\": \"14/07/2020 17:42:01\",\r\n \"status\": \"pickedUp\",\r\n \"description\": \"\",\r\n \"deliveryCompany\": \"fastExpress\",\r\n \"shipmentId\": \"92358235823\"\r\n },\r\n {\r\n \"date\": \"16/07/2020 10:42:01\",\r\n \"status\": \"delivered\",\r\n \"description\": \"\",\r\n \"deliveryCompany\": \"fastExpress\",\r\n \"shipmentId\": \"92358235823\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"
}
]
},
{
"name": "Track Shipment",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\",\r\n \"deliveryCompanyName\":\"smsaecom\",\r\n \"statusHistory\":true,\r\n \"brandName\":\"test brand\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
},
"description": "**Available Packages:** Enterprise Package, Marketplaces\n\nThis API endpoint enables you to track a shipment by providing the tracking number and delivery company name. Without requiring any authorization, it offers detailed shipment information, including tracking URL, real time status updates and status history.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| trackingNumber | yes | string | The shipment/ tracking number that you wanna track. |\n| deliveryCompanyName | yes | string | The name of the delivery company. You can get this information from `DC List` endpoint with `code` paramater |\n| statusHistory | yes | boolean(true, false) | To bring the history of the shipment. |\n| brandName | no | string | The brand name associated with the shipment. |"
},
"response": [
{
"name": "200 OK history",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"289812708\",\r\n \"deliveryCompanyName\":\"naqel\",\r\n \"statusHistory\":true\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:30:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "338"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"trackingUrl\": \"https://www.naqelexpress.com/en/sa/tracking/\",\n \"success\": true,\n \"items\": [\n {\n \"dcStatus\": \"1\",\n \"updateStatusDate\": true,\n \"shipmentId\": \"289812708\",\n \"otoStatus\": \"pickedUp\",\n \"success\": true,\n \"dcUpdateDate\": \"2024-08-15T11:36:00\",\n \"dcDescription\": \"1 Picked up by Naqel at : JEDDAH\",\n \"history\": [\n {\n \"dcStatus\": \"0\",\n \"updateStatusDate\": true,\n \"shipmentId\": \"289812708\",\n \"otoStatus\": \"shipmentCreated\",\n \"dcUpdateDate\": \"2024-08-14T15:24:13\",\n \"dcDescription\": \"0 Waybill created. Shipment has not been received from the retailer\"\n },\n {\n \"dcStatus\": \"1\",\n \"updateStatusDate\": true,\n \"shipmentId\": \"289812708\",\n \"otoStatus\": \"pickedUp\",\n \"dcUpdateDate\": \"2024-08-15T11:36:00\",\n \"dcDescription\": \"1 Picked up by Naqel at : JEDDAH\"\n }\n ]\n }\n ]\n}"
},
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\",\r\n \"deliveryCompanyName\":\"smsaecom\",\r\n \"statusHistory\":false\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:30:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "338"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"trackingUrl\": \"https://www.smsaexpress.com/trackingdetails?tracknumbers%5B0%5D=290692134777\",\n \"success\": true,\n \"items\": [\n {\n \"dcStatus\": \"DATA RECEIVED\",\n \"updateStatusDate\": true,\n \"shipmentId\": \"290692134777\",\n \"otoStatus\": \"shipmentCreated\",\n \"success\": true,\n \"dcUpdateDate\": \"2024-05-08T11:39:00\",\n \"dcDescription\": \"DATA RECEIVED - Online Data Submitted\"\n }\n ]\n}"
},
{
"name": "200 No result",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"2906921347877\",\r\n \"deliveryCompanyName\":\"smsaecom\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:31:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "121"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"trackingUrl\": \"https://www.smsaexpress.com/trackingdetails?tracknumbers%5B0%5D=2906921347877\",\n \"success\": true,\n \"items\": []\n}"
},
{
"name": "400 invalid format",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\"\r\n \"deliveryCompanyName\":\"smsa\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:32:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "102"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1075\",\n \"otoErrorMessage\":\"Invalid Json format\"\n}"
},
{
"name": "400 missing field",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"deliveryCompanyName\":\"smsa\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:32:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "102"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1010\",\n \"otoErrorMessage\":\"Check the missing details\"\n}"
},
{
"name": "400 missing field",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:32:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "102"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1010\",\n \"otoErrorMessage\":\"Check the missing details\"\n}"
},
{
"name": "409 No tracking config",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\",\r\n \"deliveryCompanyName\":\"smsa\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:32:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "102"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1004\",\n \"otoErrorMessage\":\"There is no available delivery company setting\"\n}"
},
{
"name": "409 No response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"trackingNumber\": \"290692134777\",\r\n \"deliveryCompanyName\":\"smsa\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/trackShipment",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "trackShipment"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 08 Jul 2024 14:32:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "102"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1116\",\n \"otoErrorMessage\":\"Delivery company couldn't respond properly.\"\n}"
}
]
}
]
},
{
"name": "Carrier Integrations",
"item": [
{
"name": "Check OTO Delivery Fee",
"request": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"weight\":\"3\",\r\n \"originCity\":\"Riyadh\",\r\n \"destinationCity\":\"Jeddah\",\r\n \"height\":30,\r\n \"width\":30,\r\n \"length\":30\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkOTODeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkOTODeliveryFee"]
},
"description": "**Available Packages**: All Packages\n\nThis API endpoint calculates shipping prices offered by OTO rates. By providing the origin city, destination city, and package details (such as weight and dimensions), the API computes the price based on the provided request parameters.\n\n##### Important Note:\n\n- The prices returned by this API are applicable only to shipping options available under OTO's contracts.\n \n- To calculate prices for your own custom contracts, please use the Check Delivery Fee API.\n \n- You can see the shipping prices of delivery companies regarding to your account's country information.\n \n\n##### Pricing Calculation Details:\n\n- The price is determined based on the greater value between the actual weight and the volumetric weight of the package.\n \n- Be sure to include the larger of these two values in your request.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| originCity | yes | string | pickup city |\n| destinationCity | yes | string | destination city |\n| originLat | no | number | reqired for `bullet` type |\n| originLon | no | number | reqired for `bullet` type |\n| destinationLat | no | number | reqired for `bullet` type |\n| destinationLon | no | number | reqired for `bullet` type |\n| weight\\* | yes | number | approximate weight of package(kg) |\n| forReverseShipment | no | boolean | When you set is true, it will list the delivery companies that you can create reverse shipments. |\n| currency | no | string | ISO 4217 code, \"SAR\",\"KWD\", etc |\n| packageCount | no | number | 1 |\n| totalDue | no | number | cash on delivery amount |\n| length | no | number | length of the package(cm) |\n| width | no | number | width of the package(cm) |\n| height | no | number | height of the package(cm) |\n| serviceType | no | enum | `express`,`sameDay`, `fastDelivery`, `coldDelivery`,`heavyAndBulky`, `electronicAndHeavy` |\n| deliveryType | no | enum | `toCustomerDoorstep pickupByCustomer toCustomerDoorstepOrPickupByCustomer` |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"weight\":\"3\",\r\n \"originCity\":\"Riyadh\",\r\n \"destinationCity\":\"Jeddah\",\r\n \"height\":30,\r\n \"width\":30,\r\n \"length\":30\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkOTODeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkOTODeliveryFee"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "9922201d62bc7c7f376d5d086f8b9f8b"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Thu, 29 Feb 2024 13:08:22 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "6259"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"traceId\": \"2e648363-2e85-49b3-9eea-75c9d10c09d0\",\n \"success\": true,\n \"deliveryCompany\": [\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Kwick Box\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 10,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 3750,\n \"insurancePolicy\": \"Up To 3500 SAR\",\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 345,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"kwickbox\",\n \"returnFee\": 13,\n \"maxFreeWeight\": 25,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 13,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/kwickbox.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"pudo\",\n \"deliveryOptionName\": \"SPL - PUDO\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 10000,\n \"insurancePolicy\": \"Up To 5000.00 SAR\",\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 2748,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"saudiPost\",\n \"returnFee\": 14,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 5 Working Days\",\n \"price\": 14,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/spl.jpg\",\n \"pickupDropoff\": \"dropoffOnly\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Thabit Logistics\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 3750,\n \"insurancePolicy\": \"Up To 5000 SAR\",\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 645,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"thabit\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/thabit.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Safe Arrival\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"16:00\",\n \"maxOrderValue\": 3000,\n \"insurancePolicy\": \"Up To 500 SAR\",\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 3213,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"safearrival\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/safearrival.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aymakan\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"15:00\",\n \"maxOrderValue\": 5000,\n \"insurancePolicy\": \"Up To 375 SAR\",\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 994,\n \"extraWeightPerKg\": 2,\n \"deliveryCompanyName\": \"aymakan\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aymakan.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"DELIVERIST \",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"13:00\",\n \"maxOrderValue\": 3500,\n \"insurancePolicy\": \"Up To 500 SAR\",\n \"maxCODValue\": 3500,\n \"deliveryOptionId\": 4175,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"deliveristLogestechs\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/deliverist.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Shipa Delivery\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"14:00\",\n \"maxOrderValue\": 3750,\n \"insurancePolicy\": \"Up To 100 SAR\",\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 346,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"shipaV2\",\n \"returnFee\": 20,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 20,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/shipa.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aramex\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"18:00\",\n \"maxOrderValue\": 10000,\n \"insurancePolicy\": \"Up To 1000 SAR\",\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 332,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"aramex\",\n \"returnFee\": 21,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 21,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aramex.png\",\n \"pickupDropoff\": \"freePickupDropoff\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"J&T Express\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 6000,\n \"insurancePolicy\": \"Up To 400 SAR\",\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 711,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"jtexpress\",\n \"returnFee\": 21,\n \"maxFreeWeight\": 5,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 21,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/jandt.png\",\n \"pickupDropoff\": \"freePickupDropoff\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"UPS\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"15:00\",\n \"maxOrderValue\": 5000,\n \"insurancePolicy\": \"Up To 375 SAR\",\n \"maxCODValue\": 2000,\n \"deliveryOptionId\": 1305,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"ups\",\n \"returnFee\": 22,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 5 Working Days\",\n \"price\": 22,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/ups.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"SMSA\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 6000,\n \"insurancePolicy\": \"Up To 100 SAR\",\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 979,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"secom\",\n \"returnFee\": 24,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 5 Working Days\",\n \"price\": 24,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/smsav2.png\",\n \"pickupDropoff\": \"dropoffOnly\"\n },\n {\n \"serviceType\": \"heavyAndBulky\",\n \"deliveryOptionName\": \"Flow PL\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 0,\n \"pickupCutOffTime\": \"09:00\",\n \"maxOrderValue\": 20000,\n \"insurancePolicy\": \"Up To 500 SAR\",\n \"maxCODValue\": 0,\n \"deliveryOptionId\": 2567,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"flowpl\",\n \"returnFee\": 44,\n \"maxFreeWeight\": 30,\n \"avgDeliveryTime\": \"1 to 5 Working Days\",\n \"price\": 44,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/flow.png\",\n \"pickupDropoff\": \"freePickup\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"DHL Express MyDHL\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 3750,\n \"insurancePolicy\": \"Up To 100 SAR\",\n \"maxCODValue\": 1,\n \"deliveryOptionId\": 1593,\n \"extraWeightPerKg\": 10,\n \"deliveryCompanyName\": \"mydhl\",\n \"returnFee\": 69,\n \"maxFreeWeight\": 5,\n \"avgDeliveryTime\": \"1 to 5 Working Days\",\n \"price\": 69,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/dhl-express.png\",\n \"pickupDropoff\": \"freePickupDropoff\"\n }\n ]\n}"
}
]
},
{
"name": "Check Delivery Fee",
"request": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"weight\":\"50\",\r\n \"totalDue\":10,\r\n \"originCity\":\"Riyadh\",\r\n \"destinationCity\":\"Jeddah\",\r\n \"height\":170,\r\n \"width\":50,\r\n \"length\":50\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkDeliveryFee"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint calculates contract-based pricing using your own rates. By providing the origin city, destination city, and package details such as weight and dimensions, the API determines the price based on the supplied parameters.\n\nImportant Note: The prices returned by this API apply exclusively to your own contracts.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| originCity | yes | string | pickup city |\n| destinationCity | yes | string | destination city |\n| weight | yes | number | weight of package |\n| totalDue | no | number | cash on delivery amount |\n| deliveryType | no | enum | `bullet`,`courier` |\n| originLat | no | string | reqired for `bullet` type |\n| originLon | no | string | reqired for `bullet` type |\n| destinationLat | no | string | reqired for `bullet` type |\n| destinationLon | no | string | reqired for `bullet` type |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"weight\":\"50\",\r\n \"totalDue\":10,\r\n \"originCity\":\"Riyadh\",\r\n \"destinationCity\":\"Jeddah\",\r\n \"height\":170,\r\n \"width\":50,\r\n \"length\":50\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkDeliveryFee"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 19 Nov 2023 06:10:43 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "37"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"deliveryCompany\": [\n {\n \"serviceType\": \"pudo\",\n \"deliveryOptionName\": \"SPL PUDO\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"maxOrderValue\": 10000,\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 69251112323,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"splUpds\",\n \"returnFee\": 14,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 14,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/spl.jpg\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"dropoffOnly\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 1.75% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Shipa Delivery\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 54223133116,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"shipaV2\",\n \"returnFee\": 21,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 21,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/shipa.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.8% of the amount to be collected\"\n },\n {\n \"serviceType\": \"sameDay\",\n \"deliveryOptionName\": \"DELIVERIST Same Day\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 2500,\n \"deliveryOptionId\": 5432313429,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"deliveristLogestechs\",\n \"returnFee\": 21,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"sameDayPickUp\",\n \"price\": 21,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/deliverist.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 2.5% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aymakan\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 54366343321,\n \"extraWeightPerKg\": 2,\n \"deliveryCompanyName\": \"aymakan\",\n \"returnFee\": 22,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to3WorkingDays\",\n \"price\": 22,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aymakan.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 1.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"sameDay\",\n \"deliveryOptionName\": \"Deliver Now\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 543432238,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"delivernow\",\n \"returnFee\": 22,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"Same Day of Pickup Date\",\n \"price\": 22,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/delivery-now.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.0% of the amount to be collected\"\n }\n ]\n}"
}
]
},
{
"name": "Get Delivery Fee",
"request": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-22700-1006\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryFee"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint calculates the shipping fee for a specific order in OTO. It offers two methods for price calculation:\n\n1. By Order ID: Provide the orderId, and the API will return all possible shipping rates for each defined shipping company.\n \n2. By Delivery Option ID: Provide the deliveryOptionId to calculate the shipping fee for a specific shipping company. You can get this information from checkOTODeliveryFee or from checkDeliveryFee endpoints.\n \n\n**Request Parameters:**\n\n| Name | Required | **Type** | Description |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order |\n| deliveryCompanySettingsId | no | string | Delivery Company settings id |"
},
"response": [
{
"name": "200 all options",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-22700-1006\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/getDeliveryFee",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "getDeliveryFee"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 19 Nov 2023 20:32:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "4988"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"deliveryCompany\": [\n {\n \"serviceType\": \"pudo\",\n \"deliveryOptionName\": \"SPL PUDO\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"maxOrderValue\": 10000,\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 6927,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"splUpds\",\n \"returnFee\": 13,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 13,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/spl.jpg\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"dropoffOnly\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 1.75% of the amount to be collected\"\n },\n {\n \"serviceType\": \"pudo\",\n \"deliveryOptionName\": \"SPL PUDO\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"maxOrderValue\": 10000,\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 6925,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"splUpds\",\n \"returnFee\": 14,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 14,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/spl.jpg\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"dropoffOnly\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 1.75% of the amount to be collected\"\n },\n {\n \"serviceType\": \"pudo\",\n \"deliveryOptionName\": \"SPL PUDO\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"maxOrderValue\": 10000,\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 6926,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"splUpds\",\n \"returnFee\": 14,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 14,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/spl.jpg\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"dropoffOnly\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 1.75% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Shipa Delivery\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 5552,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"shipaV2\",\n \"returnFee\": 17,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 17,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/shipa.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.8% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aramex\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"14:00\",\n \"maxOrderValue\": 7000,\n \"maxCODValue\": 5000,\n \"deliveryOptionId\": 5551,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"aramex\",\n \"returnFee\": 18,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 18,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aramex.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickupDropoff\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 1.75% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Shipa Delivery\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 5489,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"shipaV2\",\n \"returnFee\": 18,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 3 Working Days\",\n \"price\": 18,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/shipa.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.8% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"J&T Express\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"16:00\",\n \"maxOrderValue\": 6000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5555,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"jtexpress\",\n \"returnFee\": 18,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 18,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/jandt.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 0.9% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aymakan\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5557,\n \"extraWeightPerKg\": 2,\n \"deliveryCompanyName\": \"aymakan\",\n \"returnFee\": 18,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to3WorkingDays\",\n \"price\": 18,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aymakan.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 1.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"sameDay\",\n \"deliveryOptionName\": \"Deliver Now\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5564,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"delivernow\",\n \"returnFee\": 18,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"Same Day of Pickup Date\",\n \"price\": 18,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/delivery-now.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Thabit Logistics\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"13:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 5554,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"thabit\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to2WorkingDays\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/thabit.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 0.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Aymakan\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"17:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5494,\n \"extraWeightPerKg\": 2,\n \"deliveryCompanyName\": \"aymakan\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to3WorkingDays\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/aymakan.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 1.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"coldDelivery\",\n \"deliveryOptionName\": \"Delex\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 7,\n \"pickupCutOffTime\": \"10:00\",\n \"maxOrderValue\": 500,\n \"maxCODValue\": 500,\n \"deliveryOptionId\": 5568,\n \"extraWeightPerKg\": 2,\n \"deliveryCompanyName\": \"delexLogestechs\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 12,\n \"avgDeliveryTime\": \"1to3WorkingDays\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/delex.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"7.0 SAR plus 0.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"sameDay\",\n \"deliveryOptionName\": \"Deliver Now\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 3,\n \"pickupCutOffTime\": \"12:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5501,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"delivernow\",\n \"returnFee\": 19,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"Same Day of Pickup Date\",\n \"price\": 19,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/delivery-now.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"3.0 SAR plus 0.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Thabit Logistics\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 6,\n \"pickupCutOffTime\": \"13:00\",\n \"maxOrderValue\": 3750,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 5491,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"thabit\",\n \"returnFee\": 20,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to2WorkingDays\",\n \"price\": 20,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/thabit.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"6.0 SAR plus 0.0% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"J&T Express\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"pickupCutOffTime\": \"16:00\",\n \"maxOrderValue\": 6000,\n \"maxCODValue\": 3000,\n \"deliveryOptionId\": 5492,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"jtexpress\",\n \"returnFee\": 20,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1 to 2 Working Days\",\n \"price\": 20,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/jandt.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 0.9% of the amount to be collected\"\n },\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"SMSA\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 8,\n \"maxOrderValue\": 6000,\n \"maxCODValue\": 3750,\n \"deliveryOptionId\": 5556,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"secom\",\n \"returnFee\": 20,\n \"maxFreeWeight\": 15,\n \"avgDeliveryTime\": \"1to5WorkingDays\",\n \"price\": 20,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/smsa-logo.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"dropoffOnly\",\n \"cardOnDeliveryPercentage\": \"8.0 SAR plus 0.0% of the amount to be collected\"\n }\n ]\n}"
},
{
"name": "200 with specific deliveryCompanySettingsId",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-22700-1006\",\r\n \"deliveryCompanySettingsId\": 5504\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryFee"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 19 Nov 2023 20:33:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "955"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"deliveryCompany\": [\n {\n \"serviceType\": \"express\",\n \"deliveryOptionName\": \"Naqel Express\",\n \"trackingType\": \"excellent\",\n \"codCharge\": 14,\n \"pickupCutOffTime\": \"16:00\",\n \"maxOrderValue\": 5000,\n \"maxCODValue\": 3500,\n \"deliveryOptionId\": 5504,\n \"extraWeightPerKg\": 1,\n \"deliveryCompanyName\": \"naqel\",\n \"returnFee\": 24,\n \"maxFreeWeight\": 10,\n \"avgDeliveryTime\": \"1to4WorkingDays\",\n \"price\": 24,\n \"logo\": \"https://storage.googleapis.com/tryoto-public/delivery-logo/naqel.png\",\n \"currency\": \"SAR\",\n \"pickupDropoff\": \"freePickup\",\n \"cardOnDeliveryPercentage\": \"14.0 SAR plus 0.0% of the amount to be collected\"\n }\n ]\n}"
},
{
"name": "400 could not find an option with delivery company",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"OID-22700-1006\",\r\n \"deliveryCompanySettingsId\": 22954\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryFee"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 19 Nov 2023 20:36:15 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "119"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1004\",\n \"otoErrorMessage\":\"There is no available delivery company setting\"\n}"
},
{
"name": "400 no delivery option for the order",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\": \"Package Count\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryFee",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryFee"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 19 Nov 2023 20:40:52 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1004\",\n \"otoErrorMessage\":\"There is no available delivery company setting\"\n}"
}
]
},
{
"name": "Get Delivery Estimation",
"request": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"calculationData\": {\r\n \"originAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n },\r\n \"destinationAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n }\r\n },\r\n \"deliveryCompanySettingsId\": 1233,\r\n \"slaMethodType\": \"CITY_BASED\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryEstimation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryEstimation"]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to access estimated delivery dates, times, and other last-mile process details by utilizing the SLA configurations of your shipping partners. By providing key information such as the pickup and customer addresses, you can retrieve precise delivery and pickup date estimates. This capability enhances the accuracy of your shipping operations and proves invaluable for businesses and logistics providers aiming to streamline workflows and deliver reliable delivery timelines to their customers.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| calculationData | yes | JSONObject | Attributes will be used to calculate estimations |\n| deliveryCompanySettingsId | no | number | To ask for specific contract |\n| slaMethodType | no | enum | To filter contracts based on the SLA Calculation Method. Enum list: \\[\"BULLET_KM\",\"CITY_BASED\",\"DISTRICT_BASED\",\"KM_BASED\",\"TIER_BASED\"\\] |\n\n**Request Paramaters: originAddress and destinationAddress**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| city | yes | string | Pickup city and destination city separately |\n| country | yes | string | Pickup country and destination country separately |\n| lat | no | number | Reqired for bullet type |\n| lon | no | number | Reqired for bullet type |\n| district | no | number | Reqired for dtistrict based sla |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"calculationData\": {\r\n \"originAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n },\r\n \"destinationAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n }\r\n },\r\n \"deliveryCompanySettingsId\": 1233,\r\n \"slaMethodType\": \"CITY_BASED\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryEstimation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryEstimation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "c2b0f154a650504a9f5a81a1772748be"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 10 Jan 2024 14:45:30 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "419"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"result\": [\n {\n \"estimatedTransferDuration\": 3,\n \"shippingContract\": {\n \"agreementType\": \"INTEGRATOR\",\n \"deliveryCompanySettingsId\": 1233,\n \"name\": \"Smsa Ecom V2\",\n \"id\": 117,\n \"slaMethodType\": \"TIER_BASED\",\n \"deliveryIntegrationName\": \"secom\"\n },\n \"estimatedPickupDate\": \"2024-01-15\",\n \"cutOffSameDayPickup\": \"15:00\",\n \"estimatedTransferCompletionDate\": \"2024-01-18\",\n \"estimatedDeliveryDate\": \"2024-01-18\",\n \"shipmentCreateDate\": \"2024-01-10\"\n }\n ],\n \"success\": true\n}"
},
{
"name": "200 No result",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "sec-ch-ua",
"value": "\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"",
"disabled": true
},
{
"key": "sec-ch-ua-mobile",
"value": "?0",
"disabled": true
},
{
"key": "User-Agent",
"value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json",
"disabled": true
},
{
"key": "Accept",
"value": "application/json, text/plain, */*",
"disabled": true
},
{
"key": "Referer",
"value": "https://qa.tryoto.com/price-calculator",
"disabled": true
},
{
"key": "sec-ch-ua-platform",
"value": "\"Windows\"",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"calculationData\": {\r\n \"originAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n },\r\n \"destinationAddress\": {\r\n \"city\": \"Riyadh\",\r\n \"country\": \"SA\",\r\n \"lat\": 45,\r\n \"lon\": 45,\r\n \"district\": \"\"\r\n }\r\n },\r\n \"deliveryCompanySettingsId\": 2087,\r\n \"slaMethodType\": \"CITY_BASED\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryEstimation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryEstimation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "8b3985b74be2cc4e9427d898e530644d;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 10 Jan 2024 14:45:59 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "28"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"result\": [],\n \"success\": true\n}"
}
]
},
{
"name": "Check Coverage",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"lat\": \"24.28738403\",\r\n \"lon\": \"46.44305038\",\r\n \"city\": \"Riyadh\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkCoverage",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkCoverage"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to verify whether the location provided in your request is within the coverage area defined by your OTO settings, including the coverage configurations for delivery companies and the branches.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| city | yes | string | City to check coverage |\n| lat | yes | long | Latitude |\n| lon | yes | long | Longitude |\n| packageSize | no | string | `small`,`medium`,`large`,`simcard`,`iphone13`, |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"city\":\"riyadh\",\r\n \"lat\":\"24\",\r\n \"lon\":\"46\",\r\n \"packageSize\":\"simcard\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkCoverage",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkCoverage"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "fb24555c8d1b915052ac9f39d242da30;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 19 Oct 2021 08:49:07 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "84"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"branchCoverage\": true,\n \"courierDelivery\": true,\n \"success\": true,\n \"bulletDelivery\": true\n}"
},
{
"name": "401",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"lat\": \"24.28738403\",\r\n \"lon\": \"46.44305038\",\r\n \"city\": \"Riyadh\",\r\n \"packageSize\":\"simcard\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkCoverage",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkCoverage"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "WWW-Authenticate",
"value": "Bearer realm=\"https://rest-api-gate-2zoj1r36.ew.gateway.dev/rest/v2/checkCoverage\", error=\"invalid_token\""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "9062054075c24db24582ae2fd0e9fecd"
},
{
"key": "Date",
"value": "Wed, 20 Oct 2021 10:46:54 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "40"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
},
{
"name": "400 Bad Request",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"lat\": \"24.28738403\",\r\n \"city\": \"Riyadh\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/checkCoverage",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkCoverage"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "WWW-Authenticate",
"value": "Bearer realm=\"https://rest-api-gate-2zoj1r36.ew.gateway.dev/rest/v2/checkCoverage\", error=\"invalid_token\""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-Cloud-Trace-Context",
"value": "9062054075c24db24582ae2fd0e9fecd"
},
{
"key": "Date",
"value": "Wed, 20 Oct 2021 10:46:54 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "40"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-T051=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1098\",\n \"otoErrorMessage\":\"Lat and Lon is missing or invalid\"\n}"
}
]
},
{
"name": "Available Cities",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"limit\":3\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/availableCities",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "availableCities"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint retrieves a list of cities available for delivery based on your coverage settings for active delivery companies you have contracts with. To obtain results, ensure that the delivery companies' coverage areas are configured by adding cities through the OTO UI.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| page | no | number | Number of page, default is 1 |\n| limit | no | number | Number of cities in a single page, default is 100 |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"limit\":3\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/availableCities",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "availableCities"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "30615b694022d3d8fcf04c612958ca51;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Wed, 03 Nov 2021 15:33:40 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "169"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"limit\": 3,\n \"page\": 1,\n \"orders\": [\n {\n \"city\": \"Riyadh\",\n \"city_ar\": \"الرياض\"\n },\n {\n \"city\": \"Dammam\",\n \"city_ar\": \"الدمام\"\n },\n {\n \"city\": \"Jeddah\",\n \"city_ar\": \"جدة\"\n }\n ]\n}"
}
]
},
{
"name": "Available Time Slots",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"serviceType\": \"bullet\",\r\n \"packageSize\": \"simCard\",\r\n \"lat\": \"24.00\",\r\n \"lon\": \"46.00\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/availableTimeslots",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "availableTimeslots"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint retrieves the available delivery time slots for delivery companies based on their specified working hours.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| lat | no | string | Latitude |\n| lon | no | string | Longitude |\n| serviceType | yes | string | Possible values: `bullet`,`courier` |\n| packageSize | no | string | |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"serviceType\": \"bullet\",\r\n \"packageSize\": \"simCard\",\r\n \"lat\": \"24.00\",\r\n \"lon\": \"46.00\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/availableTimeslots",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "availableTimeslots"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "b9f75f4060068538cad8b739cd47b9e6;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Thu, 04 Nov 2021 06:49:08 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "36"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"availableSlots\": [\n {\n \"times\": [\n \"9:30AM-11:30AM\",\n \"11:30AM-1:30PM\",\n \"1:30PM-3:30PM\",\n \"3:30PM-5:30PM\",\n \"5:30PM-7:30PM\",\n \"7:30PM-9:30PM\",\n \"9:30PM-11:30PM\"\n ],\n \"day\": \"05/11/2020\"\n },\n {\n \"times\": [\n \"5:30PM-7:30PM\",\n \"7:30PM-9:30PM\",\n \"9:30PM-11:30PM\"\n ],\n \"day\": \"06/11/2020\"\n },\n {\n \"times\": [\n \"9:30AM-11:30AM\",\n \"11:30AM-1:30PM\",\n \"1:30PM-3:30PM\",\n \"3:30PM-5:30PM\",\n \"5:30PM-7:30PM\",\n \"7:30PM-9:30PM\",\n \"9:30PM-11:30PM\"\n ],\n \"day\": \"07/11/2020\"\n }\n ]\n}"
}
]
},
{
"name": "DC List",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/dcList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "dcList"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides a list of all delivery companies integrated with OTO. If you have a contract with any of these companies, you can connect your account to OTO. Use the company's unique code to configure settings through the **DC Activation** and **DC Config** API endpoints.\n\nIf a delivery company you have a contract with is not listed, please notify us to initiate the integration process."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/dcList",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "dcList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "1eb9d134855ffb0a5fba73ec6ef2ea55;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 06:48:40 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "4380"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"Name\": \"3speeds\",\n \"code\": \"3speeds\"\n },\n {\n \"Name\": \"4PL\",\n \"code\": \"4pl\"\n },\n {\n \"Name\": \"4U Express\",\n \"code\": \"4uexpress\"\n },\n {\n \"Name\": \"4U Logistics\",\n \"code\": \"4u\"\n },\n {\n \"Name\": \"9Cloud\",\n \"code\": \"9cloud\"\n },\n {\n \"Name\": \"Adam Pharmacy\",\n \"code\": \"adamPharmacy\"\n },\n {\n \"Name\": \"Adwar Logistics\",\n \"code\": \"adwar\"\n },\n {\n \"Name\": \"Adwar Logistics (Logestechs)\",\n \"code\": \"adwarLogestechs\"\n },\n {\n \"Name\": \"AHOY\",\n \"code\": \"ahoy\"\n },\n {\n \"Name\": \"Ajalogistic\",\n \"code\": \"ajalogistic\"\n },\n {\n \"Name\": \"Ajeek\",\n \"code\": \"ajeek\"\n },\n {\n \"Name\": \"AJEX Logistics\",\n \"code\": \"ajex\"\n },\n {\n \"Name\": \"AJEX Türkiye\",\n \"code\": \"ajex-tr\"\n },\n {\n \"Name\": \"Ajoul\",\n \"code\": \"ajoul\"\n },\n {\n \"Name\": \"Ajwaa Afaq\",\n \"code\": \"ajwa\"\n },\n {\n \"Name\": \"Al Hajer Logistics\",\n \"code\": \"alhajer\"\n },\n {\n \"Name\": \"Al Saif Express\",\n \"code\": \"alsaifexpress\"\n },\n {\n \"Name\": \"Al Shouroq express\",\n \"code\": \"alshouroq\"\n },\n {\n \"Name\": \"Alam alkon\",\n \"code\": \"alamalkon\"\n },\n {\n \"Name\": \"Alamyal\",\n \"code\": \"alamyal\"\n },\n {\n \"Name\": \"Albabtain Logistic\",\n \"code\": \"albabtainLogistic\"\n },\n {\n \"Name\": \"Alma Express\",\n \"code\": \"alma\"\n },\n {\n \"Name\": \"Altariq App\",\n \"code\": \"altariq\"\n },\n {\n \"Name\": \"Anwan Express\",\n \"code\": \"anwan\"\n },\n {\n \"Name\": \"Araba Shipping Service\",\n \"code\": \"araba\"\n },\n {\n \"Name\": \"Aramex\",\n \"code\": \"aramex\"\n },\n {\n \"Name\": \"Aras Kargo\",\n \"code\": \"araskargo\"\n },\n {\n \"Name\": \"Asyad Express\",\n \"code\": \"asyadV2\"\n },\n {\n \"Name\": \"Atheryoun Express\",\n \"code\": \"atheryoun\"\n },\n {\n \"Name\": \"Awfar Express\",\n \"code\": \"awfar\"\n },\n {\n \"Name\": \"Awssal\",\n \"code\": \"awssal\"\n },\n {\n \"Name\": \"Aymakan\",\n \"code\": \"aymakan\"\n },\n {\n \"Name\": \"Banabikurye\",\n \"code\": \"banabikurye\"\n },\n {\n \"Name\": \"Barig Logistics\",\n \"code\": \"barig\"\n },\n {\n \"Name\": \"Barq Express\",\n \"code\": \"barqexpress\"\n },\n {\n \"Name\": \"Barq Fleet\",\n \"code\": \"barq\"\n },\n {\n \"Name\": \"Barq Jawhara\",\n \"code\": \"barq-jawhara\"\n },\n {\n \"Name\": \"Beebolt\",\n \"code\": \"beebolt\"\n },\n {\n \"Name\": \"BeeThere Delivery\",\n \"code\": \"beethere\"\n },\n {\n \"Name\": \"Beez\",\n \"code\": \"beez\"\n },\n {\n \"Name\": \"Beone\",\n \"code\": \"beone\"\n },\n {\n \"Name\": \"Beone Fulfillment V2\",\n \"code\": \"beoneFfl\"\n },\n {\n \"Name\": \"Beone Lastmile\",\n \"code\": \"beoneLastmile\"\n },\n {\n \"Name\": \"Best One\",\n \"code\": \"bestone\"\n },\n {\n \"Name\": \"Beyond Delivery\",\n \"code\": \"beyondDelivery\"\n },\n {\n \"Name\": \"BlueSky Express\",\n \"code\": \"bskyexpress\"\n },\n {\n \"Name\": \"Bolt Kargo\",\n \"code\": \"boltkargo\"\n },\n {\n \"Name\": \"Bosta\",\n \"code\": \"bostaV2\"\n },\n {\n \"Name\": \"Boxed Up\",\n \"code\": \"boxedup\"\n },\n {\n \"Name\": \"Boxex Express\",\n \"code\": \"boxex\"\n },\n {\n \"Name\": \"BTC Logistics\",\n \"code\": \"btclogistic\"\n },\n {\n \"Name\": \"Captain H\",\n \"code\": \"captainh\"\n },\n {\n \"Name\": \"Careem\",\n \"code\": \"careem\"\n },\n {\n \"Name\": \"Cigo\",\n \"code\": \"cigo\"\n },\n {\n \"Name\": \"Cloud Express\",\n \"code\": \"cloudexpress\"\n },\n {\n \"Name\": \"Cloud Shelf\",\n \"code\": \"cloud-shelf\"\n },\n {\n \"Name\": \"Coldt\",\n \"code\": \"coldt\"\n },\n {\n \"Name\": \"Collect+\",\n \"code\": \"collectplus\"\n },\n {\n \"Name\": \"Dal\",\n \"code\": \"channels\"\n },\n {\n \"Name\": \"Dal Cross City\",\n \"code\": \"dalCrossCity\"\n },\n {\n \"Name\": \"Dal Fulfillment\",\n \"code\": \"channelsfulfillment\"\n },\n {\n \"Name\": \"Dash Delivery\",\n \"code\": \"dashSaudi\"\n },\n {\n \"Name\": \"Dayer Logistics\",\n \"code\": \"dayer\"\n },\n {\n \"Name\": \"Dele Fast\",\n \"code\": \"delefast\"\n },\n {\n \"Name\": \"Delex\",\n \"code\": \"delex\"\n },\n {\n \"Name\": \"Delex (Logestechs)\",\n \"code\": \"delexLogestechs\"\n },\n {\n \"Name\": \"Delifast\",\n \"code\": \"delifast\"\n },\n {\n \"Name\": \"Deliver Now Logistics\",\n \"code\": \"delivernow\"\n },\n {\n \"Name\": \"Deliverist\",\n \"code\": \"deliverist\"\n },\n {\n \"Name\": \"Deliverist (Logestechs)\",\n \"code\": \"deliveristLogestechs\"\n },\n {\n \"Name\": \"Delivery Support\",\n \"code\": \"deliverysupport\"\n },\n {\n \"Name\": \"Delybell\",\n \"code\": \"delybell\"\n },\n {\n \"Name\": \"DHL Express MyDHL\",\n \"code\": \"mydhl\"\n },\n {\n \"Name\": \"DHL Türkiye\",\n \"code\": \"dhlTr\"\n },\n {\n \"Name\": \"DOS Express\",\n \"code\": \"dosexpress\"\n },\n {\n \"Name\": \"Drb Express\",\n \"code\": \"drbexpress\"\n },\n {\n \"Name\": \"Easy Delivery\",\n \"code\": \"easyDelivery\"\n },\n {\n \"Name\": \"Ejack\",\n \"code\": \"ejack\"\n },\n {\n \"Name\": \"Elite\",\n \"code\": \"elite\"\n },\n {\n \"Name\": \"Emdad\",\n \"code\": \"emdad\"\n },\n {\n \"Name\": \"Emirates Post\",\n \"code\": \"emiratespost\"\n },\n {\n \"Name\": \"EMX\",\n \"code\": \"emx\"\n },\n {\n \"Name\": \"Esal Parcel Transport Company\",\n \"code\": \"esal\"\n },\n {\n \"Name\": \"Esnad Express\",\n \"code\": \"esnad\"\n },\n {\n \"Name\": \"Eva Express\",\n \"code\": \"evaexpress\"\n },\n {\n \"Name\": \"Falcon Express\",\n \"code\": \"falconExpress\"\n },\n {\n \"Name\": \"Fareye\",\n \"code\": \"fareye\"\n },\n {\n \"Name\": \"Fast Move Express\",\n \"code\": \"fastMove\"\n },\n {\n \"Name\": \"Fastlo\",\n \"code\": \"fastlo\"\n },\n {\n \"Name\": \"Fawran Logistics\",\n \"code\": \"fawran\"\n },\n {\n \"Name\": \"Fazaah Logistics\",\n \"code\": \"fazaahLogistics\"\n },\n {\n \"Name\": \"Fedex\",\n \"code\": \"fedex\"\n },\n {\n \"Name\": \"FedEx Uluslararası (PTS)\",\n \"code\": \"ptsv5FedEx\"\n },\n {\n \"Name\": \"FedexGlobal\",\n \"code\": \"fedexGlobal\"\n },\n {\n \"Name\": \"Fenix Express\",\n \"code\": \"fenix\"\n },\n {\n \"Name\": \"Fenx Kuwait\",\n \"code\": \"fenxKuwait\"\n },\n {\n \"Name\": \"Flexe Express\",\n \"code\": \"flexe\"\n },\n {\n \"Name\": \"Flexible\",\n \"code\": \"flexible\"\n },\n {\n \"Name\": \"Flickapp\",\n \"code\": \"flickapp\"\n },\n {\n \"Name\": \"Flow Business - Flow LTD\",\n \"code\": \"flowldt\"\n },\n {\n \"Name\": \"Flow Express\",\n \"code\": \"flowexpress\"\n },\n {\n \"Name\": \"Flowpl\",\n \"code\": \"flowpl\"\n },\n {\n \"Name\": \"FODEL\",\n \"code\": \"fodel\"\n },\n {\n \"Name\": \"Fulfillment Bridge\",\n \"code\": \"fulfillmentbridge\"\n },\n {\n \"Name\": \"FULLex\",\n \"code\": \"fullex\"\n },\n {\n \"Name\": \"Galaxy Delivery\",\n \"code\": \"galaxy\"\n },\n {\n \"Name\": \"Gawamen\",\n \"code\": \"gawamen\"\n },\n {\n \"Name\": \"Genac\",\n \"code\": \"genac\"\n },\n {\n \"Name\": \"Getswift\",\n \"code\": \"getswift\"\n },\n {\n \"Name\": \"GFS Express\",\n \"code\": \"gfsexpress\"\n },\n {\n \"Name\": \"GLC\",\n \"code\": \"glcLogestechs\"\n },\n {\n \"Name\": \"GLT Express\",\n \"code\": \"gltexpress\"\n },\n {\n \"Name\": \"Happiness Gem\",\n \"code\": \"happinessgem\"\n },\n {\n \"Name\": \"Hawa Logistics\",\n \"code\": \"hawa\"\n },\n {\n \"Name\": \"Hejen Expresss\",\n \"code\": \"hejen\"\n },\n {\n \"Name\": \"HepsiJet\",\n \"code\": \"hepsijet\"\n },\n {\n \"Name\": \"HepsiJet Marketplace\",\n \"code\": \"hepsijetmarketplace\"\n },\n {\n \"Name\": \"Hiblocks\",\n \"code\": \"hiblocks\"\n },\n {\n \"Name\": \"Holol Al Diar\",\n \"code\": \"holol-aldiar\"\n },\n {\n \"Name\": \"Horizon Speed\",\n \"code\": \"horizons\"\n },\n {\n \"Name\": \"Horoz Lojistik\",\n \"code\": \"horoz\"\n },\n {\n \"Name\": \"Horoz Lojistik Pazaryeri\",\n \"code\": \"horoz-marketplace\"\n },\n {\n \"Name\": \"İletmen\",\n \"code\": \"iletmen\"\n },\n {\n \"Name\": \"iMile\",\n \"code\": \"imile\"\n },\n {\n \"Name\": \"IntercityXpress\",\n \"code\": \"intercityxpress\"\n },\n {\n \"Name\": \"J&T Express\",\n \"code\": \"jtexpress\"\n },\n {\n \"Name\": \"Jana Express\",\n \"code\": \"janaExpress\"\n },\n {\n \"Name\": \"Jeebly\",\n \"code\": \"jeebly\"\n },\n {\n \"Name\": \"Jeebly Now\",\n \"code\": \"jeeblynow\"\n },\n {\n \"Name\": \"Jeebly V2\",\n \"code\": \"jeeblyV2\"\n },\n {\n \"Name\": \"Jetizz\",\n \"code\": \"jetizz\"\n },\n {\n \"Name\": \"JFL Express\",\n \"code\": \"jflexpress\"\n },\n {\n \"Name\": \"Jones International Transportation Co.\",\n \"code\": \"jonestco\"\n },\n {\n \"Name\": \"Jumia Logistics\",\n \"code\": \"jumia\"\n },\n {\n \"Name\": \"KargoIst\",\n \"code\": \"kargoist\"\n },\n {\n \"Name\": \"Kargoist\",\n \"code\": \"kargoistmarketplace\"\n },\n {\n \"Name\": \"Kasib Express\",\n \"code\": \"kasib\"\n },\n {\n \"Name\": \"Kedan\",\n \"code\": \"kedan\"\n },\n {\n \"Name\": \"Kolay Gelsin\",\n \"code\": \"kolaygelsin\"\n },\n {\n \"Name\": \"Kolay Gelsin (OTO)\",\n \"code\": \"kolaygelsin-marketplace\"\n },\n {\n \"Name\": \"Kwick Box\",\n \"code\": \"kwickbox\"\n },\n {\n \"Name\": \"Labaih\",\n \"code\": \"labaih\"\n },\n {\n \"Name\": \"Lafasta\",\n \"code\": \"lafasta\"\n },\n {\n \"Name\": \"Lafasta V4\",\n \"code\": \"lafastaV4\"\n },\n {\n \"Name\": \"Lamha\",\n \"code\": \"lamha\"\n },\n {\n \"Name\": \"Last Step\",\n \"code\": \"laststep\"\n },\n {\n \"Name\": \"LastPoint\",\n \"code\": \"lastpoint\"\n },\n {\n \"Name\": \"Logistic Care\",\n \"code\": \"logcare\"\n },\n {\n \"Name\": \"Logistic Supplier\",\n \"code\": \"logisticSupplier\"\n },\n {\n \"Name\": \"Logistiq\",\n \"code\": \"logistiq\"\n },\n {\n \"Name\": \"Lyve\",\n \"code\": \"lyve\"\n },\n {\n \"Name\": \"Lyve Bullet\",\n \"code\": \"lyve317\"\n },\n {\n \"Name\": \"Macm\",\n \"code\": \"macm\"\n },\n {\n \"Name\": \"Madar Express\",\n \"code\": \"madarexpress\"\n },\n {\n \"Name\": \"Magic Delivery\",\n \"code\": \"magicexpress\"\n },\n {\n \"Name\": \"Mahmool\",\n \"code\": \"mahmool\"\n },\n {\n \"Name\": \"MajEx Express\",\n \"code\": \"majex\"\n },\n {\n \"Name\": \"MATP Logistics\",\n \"code\": \"matp\"\n },\n {\n \"Name\": \"Milenow\",\n \"code\": \"milenow\"\n },\n {\n \"Name\": \"Miles Speed\",\n \"code\": \"milespeeds\"\n },\n {\n \"Name\": \"Mina Excellence\",\n \"code\": \"minaExcellence\"\n },\n {\n \"Name\": \"Mkhdoom\",\n \"code\": \"mkhdoom\"\n },\n {\n \"Name\": \"Mlc Go\",\n \"code\": \"mlcgo\"\n },\n {\n \"Name\": \"MNG Kargo\",\n \"code\": \"mngkargo\"\n },\n {\n \"Name\": \"MNG Kargo (OTO)\",\n \"code\": \"mngkargo-marketplace\"\n },\n {\n \"Name\": \"Modern Support \",\n \"code\": \"msc\"\n },\n {\n \"Name\": \"Moments Logistics Service\",\n \"code\": \"momentsksa\"\n },\n {\n \"Name\": \"Moovo Express\",\n \"code\": \"moovo\"\n },\n {\n \"Name\": \"Mosool\",\n \"code\": \"mosool\"\n },\n {\n \"Name\": \"Motqen\",\n \"code\": \"motqen\"\n },\n {\n \"Name\": \"Mowasalt\",\n \"code\": \"mowasalt\"\n },\n {\n \"Name\": \"MQ Express\",\n \"code\": \"mqexpress\"\n },\n {\n \"Name\": \"Mrsool\",\n \"code\": \"mrsool\"\n },\n {\n \"Name\": \"Munch On\",\n \"code\": \"munchon\"\n },\n {\n \"Name\": \"Mylerz\",\n \"code\": \"mylerz\"\n },\n {\n \"Name\": \"Najiz\",\n \"code\": \"najiz\"\n },\n {\n \"Name\": \"Najiz Express\",\n \"code\": \"najizxpress\"\n },\n {\n \"Name\": \"Naqel Bullet\",\n \"code\": \"naqelbullet\"\n },\n {\n \"Name\": \"Naqel express\",\n \"code\": \"naqel\"\n },\n {\n \"Name\": \"Naqel Fulfillment\",\n \"code\": \"naqelfulfillment\"\n },\n {\n \"Name\": \"Naql Express\",\n \"code\": \"naql\"\n },\n {\n \"Name\": \"Naseem Cold Delivery\",\n \"code\": \"naseem\"\n },\n {\n \"Name\": \"Nashmi\",\n \"code\": \"nashmiLogestechs\"\n },\n {\n \"Name\": \"Nasxpress\",\n \"code\": \"nasxpress\"\n },\n {\n \"Name\": \"nGage\",\n \"code\": \"ngage\"\n },\n {\n \"Name\": \"NiceOne Fleet\",\n \"code\": \"niceOneFleet\"\n },\n {\n \"Name\": \"Nizar Logistics\",\n \"code\": \"nizar\"\n },\n {\n \"Name\": \"Nord Logistics\",\n \"code\": \"nordlogistics\"\n },\n {\n \"Name\": \"NYAZIK Logistics\",\n \"code\": \"nyazik\"\n },\n {\n \"Name\": \"Octovan\",\n \"code\": \"octovan\"\n },\n {\n \"Name\": \"Okadoc\",\n \"code\": \"okadoc\"\n },\n {\n \"Name\": \"Omni Llama\",\n \"code\": \"omnillama\"\n },\n {\n \"Name\": \"One Click Delivery\",\n \"code\": \"oneclick\"\n },\n {\n \"Name\": \"Ontime Express\",\n \"code\": \"ontime\"\n },\n {\n \"Name\": \"Onway\",\n \"code\": \"onway\"\n },\n {\n \"Name\": \"OTO DMS\",\n \"code\": \"OTODMS\"\n },\n {\n \"Name\": \"OTO Flex\",\n \"code\": \"otoDriverApp\"\n },\n {\n \"Name\": \"PackUpp Delivery\",\n \"code\": \"packupp\"\n },\n {\n \"Name\": \"Paket Taxi\",\n \"code\": \"pakettaxi\"\n },\n {\n \"Name\": \"PDC\",\n \"code\": \"pdc\"\n },\n {\n \"Name\": \"Pharmaciaty\",\n \"code\": \"pharmaciaty\"\n },\n {\n \"Name\": \"Pharmaciaty TMS\",\n \"code\": \"pharmaciatyTMS\"\n },\n {\n \"Name\": \"Placer\",\n \"code\": \"placer\"\n },\n {\n \"Name\": \"Porter Express\",\n \"code\": \"porterex\"\n },\n {\n \"Name\": \"Posta Plus V2\",\n \"code\": \"postaPlusV2\"\n },\n {\n \"Name\": \"Postage Fulfillment\",\n \"code\": \"postageFulfillment\"\n },\n {\n \"Name\": \"Postagexp\",\n \"code\": \"postagexp\"\n },\n {\n \"Name\": \"PostaPlus\",\n \"code\": \"postaplus\"\n },\n {\n \"Name\": \"Premium Shipping\",\n \"code\": \"premium-shipping\"\n },\n {\n \"Name\": \"Pro Logistics\",\n \"code\": \"prolo\"\n },\n {\n \"Name\": \"PTL Logistics\",\n \"code\": \"ptlLogistics\"\n },\n {\n \"Name\": \"PTS Flex Uluslararası\",\n \"code\": \"ptsv5Flex\"\n },\n {\n \"Name\": \"PTT Kargo\",\n \"code\": \"pttKargo\"\n },\n {\n \"Name\": \"Qatar Post\",\n \"code\": \"qatarpost\"\n },\n {\n \"Name\": \"QDelivery\",\n \"code\": \"qdelivery\"\n },\n {\n \"Name\": \"QLS Express\",\n \"code\": \"qlsexpress\"\n },\n {\n \"Name\": \"Quick Ship\",\n \"code\": \"quickship\"\n },\n {\n \"Name\": \"Quick Silver\",\n \"code\": \"quicksilver\"\n },\n {\n \"Name\": \"Quiqup\",\n \"code\": \"quiqup\"\n },\n {\n \"Name\": \"R2 Express\",\n \"code\": \"r2express\"\n },\n {\n \"Name\": \"R2S Logistics\",\n \"code\": \"r2slogistics\"\n },\n {\n \"Name\": \"Rabbit Delivery\",\n \"code\": \"rabbitsa\"\n },\n {\n \"Name\": \"Rabel Express\",\n \"code\": \"rabel\"\n },\n {\n \"Name\": \"ReceiveHere\",\n \"code\": \"receivehere\"\n },\n {\n \"Name\": \"RedBox\",\n \"code\": \"redbox\"\n },\n {\n \"Name\": \"Redbox V2\",\n \"code\": \"redboxv2\"\n },\n {\n \"Name\": \"Reverse Delivery\",\n \"code\": \"reverseDelivery\"\n },\n {\n \"Name\": \"Road logistics\",\n \"code\": \"roadlogistic\"\n },\n {\n \"Name\": \"Roban AlQiadah\",\n \"code\": \"robanAlQiadah\"\n },\n {\n \"Name\": \"Roz Express\",\n \"code\": \"rozexpress\"\n },\n {\n \"Name\": \"Run-X Logistics\",\n \"code\": \"runx\"\n },\n {\n \"Name\": \"Runner\",\n \"code\": \"runner\"\n },\n {\n \"Name\": \"S:Mile\",\n \"code\": \"smile\"\n },\n {\n \"Name\": \"SaaSMile\",\n \"code\": \"saasmile\"\n },\n {\n \"Name\": \"SACO LM\",\n \"code\": \"medscan\"\n },\n {\n \"Name\": \"Saee\",\n \"code\": \"saee\"\n },\n {\n \"Name\": \"Safe Arrival \",\n \"code\": \"safearrival\"\n },\n {\n \"Name\": \"Safe Box\",\n \"code\": \"safebox\"\n },\n {\n \"Name\": \"Sahab Express\",\n \"code\": \"sahabexpress\"\n },\n {\n \"Name\": \"Sahab Logistics\",\n \"code\": \"sahabLogistics\"\n },\n {\n \"Name\": \"Sahm\",\n \"code\": \"sahm\"\n },\n {\n \"Name\": \"Salasa (API Dog)\",\n \"code\": \"salasaApiDog\"\n },\n {\n \"Name\": \"Sarokh\",\n \"code\": \"sarokh\"\n },\n {\n \"Name\": \"Saudi Salam Logistics\",\n \"code\": \"salam\"\n },\n {\n \"Name\": \"Send\",\n \"code\": \"send\"\n },\n {\n \"Name\": \"Shgardi\",\n \"code\": \"shgardi\"\n },\n {\n \"Name\": \"Ship Hero\",\n \"code\": \"shiphero\"\n },\n {\n \"Name\": \"Shipa\",\n \"code\": \"shipa\"\n },\n {\n \"Name\": \"Shipa Delivery V2\",\n \"code\": \"shipaV2\"\n },\n {\n \"Name\": \"Shipa Fulfillment\",\n \"code\": \"shipafulfillment\"\n },\n {\n \"Name\": \"Shipco Transport\",\n \"code\": \"shipco\"\n },\n {\n \"Name\": \"ShipEntegra\",\n \"code\": \"shipEntegra\"\n },\n {\n \"Name\": \"Shipox\",\n \"code\": \"shipox\"\n },\n {\n \"Name\": \"Shuttle\",\n \"code\": \"shuttle\"\n },\n {\n \"Name\": \"Skip Express\",\n \"code\": \"skipexpress\"\n },\n {\n \"Name\": \"Skynet\",\n \"code\": \"skynet\"\n },\n {\n \"Name\": \"SLD (Saudi Logistics and Delivery)\",\n \"code\": \"sld\"\n },\n {\n \"Name\": \"SLS Express\",\n \"code\": \"sls\"\n },\n {\n \"Name\": \"SLSC Logistic\",\n \"code\": \"slsclogsitic\"\n },\n {\n \"Name\": \"Smart Point\",\n \"code\": \"smartpoint\"\n },\n {\n \"Name\": \"SMB Express\",\n \"code\": \"smbexpress\"\n },\n {\n \"Name\": \"SMI Express\",\n \"code\": \"smiexpress\"\n },\n {\n \"Name\": \"SMSA B2B\",\n \"code\": \"smsab2b\"\n },\n {\n \"Name\": \"Smsa Ecom V2\",\n \"code\": \"secom\"\n },\n {\n \"Name\": \"Smsa Express\",\n \"code\": \"smsaV2\"\n },\n {\n \"Name\": \"Smsa Omni\",\n \"code\": \"smsaomni\"\n },\n {\n \"Name\": \"SMSA SDM\",\n \"code\": \"smsasdm\"\n },\n {\n \"Name\": \"Soon Express\",\n \"code\": \"soonexpress\"\n },\n {\n \"Name\": \"Sor3a Express\",\n \"code\": \"sor3aexpress\"\n },\n {\n \"Name\": \"Speed Logistics\",\n \"code\": \"speedLogistics\"\n },\n {\n \"Name\": \"SPL\",\n \"code\": \"saudiPost\"\n },\n {\n \"Name\": \"SPL Fulfillment\",\n \"code\": \"splfulfillment\"\n },\n {\n \"Name\": \"SPL UPDS\",\n \"code\": \"splUpds\"\n },\n {\n \"Name\": \"SPL V2\",\n \"code\": \"saudiPostV2\"\n },\n {\n \"Name\": \"Sprint\",\n \"code\": \"sprint\"\n },\n {\n \"Name\": \"Sps Express\",\n \"code\": \"spsexpress\"\n },\n {\n \"Name\": \"Starlinks\",\n \"code\": \"starlinks\"\n },\n {\n \"Name\": \"Starlinks (New)\",\n \"code\": \"starlinksNew\"\n },\n {\n \"Name\": \"Styla Sewa\",\n \"code\": \"stylasewa\"\n },\n {\n \"Name\": \"Sundouq\",\n \"code\": \"sundouq\"\n },\n {\n \"Name\": \"Sürat Kargo (OTO)\",\n \"code\": \"surat-kargo-marketplace\"\n },\n {\n \"Name\": \"SWEX Express\",\n \"code\": \"swex\"\n },\n {\n \"Name\": \"Swift\",\n \"code\": \"swift\"\n },\n {\n \"Name\": \"Syaal\",\n \"code\": \"syaal\"\n },\n {\n \"Name\": \"Tabex\",\n \"code\": \"tabex\"\n },\n {\n \"Name\": \"Tal Delivery\",\n \"code\": \"talDelivery\"\n },\n {\n \"Name\": \"Tam\",\n \"code\": \"tam\"\n },\n {\n \"Name\": \"Tamex\",\n \"code\": \"tamex\"\n },\n {\n \"Name\": \"Tard Delivery\",\n \"code\": \"tard\"\n },\n {\n \"Name\": \"Tard Delivery 2\",\n \"code\": \"tardV2\"\n },\n {\n \"Name\": \"Tasawuq\",\n \"code\": \"tasawuq\"\n },\n {\n \"Name\": \"Tawsela\",\n \"code\": \"tawsela\"\n },\n {\n \"Name\": \"Tawzea Logistics\",\n \"code\": \"tawzea\"\n },\n {\n \"Name\": \"TD Logistics\",\n \"code\": \"touchDown\"\n },\n {\n \"Name\": \"TFM Express\",\n \"code\": \"tfmexpress\"\n },\n {\n \"Name\": \"Thabit Logistics\",\n \"code\": \"thabit\"\n },\n {\n \"Name\": \"The Arrow\",\n \"code\": \"thearrow\"\n },\n {\n \"Name\": \"Tookan\",\n \"code\": \"tookan\"\n },\n {\n \"Name\": \"Transcorp\",\n \"code\": \"transcorp\"\n },\n {\n \"Name\": \"UPS\",\n \"code\": \"ups\"\n },\n {\n \"Name\": \"UPS OAuth\",\n \"code\": \"ups2\"\n },\n {\n \"Name\": \"UPS Uluslararası (PTS)\",\n \"code\": \"ptsv5Ups\"\n },\n {\n \"Name\": \"Uruk Express\",\n \"code\": \"uruk\"\n },\n {\n \"Name\": \"USPS\",\n \"code\": \"usps\"\n },\n {\n \"Name\": \"uTrac\",\n \"code\": \"utrac\"\n },\n {\n \"Name\": \"Utrac Delivery\",\n \"code\": \"utracDelivery\"\n },\n {\n \"Name\": \"VAAL\",\n \"code\": \"vaal\"\n },\n {\n \"Name\": \"Wadha\",\n \"code\": \"wadha\"\n },\n {\n \"Name\": \"Waseel Logistics\",\n \"code\": \"waseel\"\n },\n {\n \"Name\": \"Waslnee\",\n \"code\": \"waslnee\"\n },\n {\n \"Name\": \"Way Express\",\n \"code\": \"wayexpress\"\n },\n {\n \"Name\": \"WeDeliver\",\n \"code\": \"wedeliver\"\n },\n {\n \"Name\": \"Weenk App\",\n \"code\": \"weenkapp\"\n },\n {\n \"Name\": \"Wepik Express\",\n \"code\": \"wepikexpress\"\n },\n {\n \"Name\": \"XTurbo\",\n \"code\": \"xturbo\"\n },\n {\n \"Name\": \"Yallow\",\n \"code\": \"yallow\"\n },\n {\n \"Name\": \"Yamamah Express\",\n \"code\": \"yamamahexpress\"\n },\n {\n \"Name\": \"Yamamah Express Logestechs\",\n \"code\": \"yamamahLogestechs\"\n },\n {\n \"Name\": \"Yango\",\n \"code\": \"yango\"\n },\n {\n \"Name\": \"Yango Next Day Delivery\",\n \"code\": \"yangondd\"\n },\n {\n \"Name\": \"Yeswa\",\n \"code\": \"yeswa\"\n },\n {\n \"Name\": \"Yurtiçi Kargo\",\n \"code\": \"yurticiKargo\"\n },\n {\n \"Name\": \"Yurtiçi Kargo\",\n \"code\": \"yurtici-kargo-marketplace\"\n },\n {\n \"Name\": \"Zajel\",\n \"code\": \"zajel\"\n },\n {\n \"Name\": \"Zajil\",\n \"code\": \"zajil\"\n }\n ],\n \"success\": true\n}"
}
]
},
{
"name": "DC Config",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\":\"aramex\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/dcConfig",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "dcConfig"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to view the required account credentials and the template for the delivery company specified in the request, which are needed for the next step: DC activation. \nRetrieve the delivery company configuration template. \nUse this template to create a valid configuration object, similar to the given `exampleJson`. \nThis configuration object is then used to activate the delivery company with the `DC Activation` API endpoint.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| code | yes | string | The integration name obtained from the DC List. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\":\"aramex\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/dcConfig",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "dcConfig"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "665037e4022cd58163e6ab40071a6d60"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 06:50:09 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "943"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"settings\": [\n {\n \"fieldName\": \"UserName\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"Password\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"Version\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"AccountNumber\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"AccountPin\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"AccountEntity\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"AccountCountryCode\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"Source\",\n \"parentJson\": \"ClientInfo\",\n \"fieldType\": \"string\"\n },\n {\n \"fieldName\": \"productType\",\n \"fieldType\": \"enum\",\n \"enumValues\": \"EPX,CDS,OND,GPX,GDX,DPX,DDX,PLX,PPX,PDX\"\n }\n ],\n \"success\": true,\n \"exampleJSON\": {\n \"delivery_fee\": 0,\n \"rating\": 0,\n \"ClientInfo\": {\n \"UserName\": \"\",\n \"Version\": \"v1\",\n \"AccountPin\": \"\",\n \"AccountCountryCode\": \"SA\",\n \"AccountEntity\": \"RUH\",\n \"Source\": 24,\n \"Password\": \"\",\n \"AccountNumber\": \"\"\n },\n \"productType\": \"CDS\"\n }\n}"
}
]
},
{
"name": "DC Activation",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\":\"aramex\",\r\n \"deliveryOptionName\":\"api test aramex\",\r\n \"settings\":{\r\n \"ClientInfo\": {\r\n \"UserName\": \"[email protected]\",\r\n \"Version\": \"v1\",\r\n \"AccountPin\": \"123\",\r\n \"AccountCountryCode\": \"SA\",\r\n \"AccountEntity\": \"RUH\",\r\n \"Source\": 24,\r\n \"Password\": \"123abc\",\r\n \"AccountNumber\": \"123456\"\r\n },\r\n \"productType\": \"CDS\"\r\n }\r\n \r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/dcActivation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "dcActivation"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint is used to perform Delivery Company (DC) activation. It enables you to activate a delivery company by providing the required configuration details.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| code | yes | string | The integration name obtained from the `DC List.` |\n| deliveryOptionName | yes | string | A name you assign to easily identify this configuration. |\n| brandId | no | number | id of the brand created by `Create Brand` endpoint |\n| settings | yes | object | A configuration object created based on the example provided by the `DC Config` endpoint. |\n\nNote: You can activate 1 DC for the Free package and 3 DC for the Starter package and unlimited for other packages."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\":\"aramex\",\r\n \"deliveryOptionName\":\"api test aramex\",\r\n \"brandID\": 123,\r\n \"settings\":{\r\n \"ClientInfo\": {\r\n \"UserName\": \"[email protected]\",\r\n \"Version\": \"v1\",\r\n \"AccountPin\": \"123\",\r\n \"AccountCountryCode\": \"SA\",\r\n \"AccountEntity\": \"RUH\",\r\n \"Source\": 24,\r\n \"Password\": \"123abc\",\r\n \"AccountNumber\": \"123456\"\r\n },\r\n \"productType\": \"CDS\"\r\n }\r\n \r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/dcActivation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "dcActivation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "f474b1f2ae9d6506663056823aae78a0;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 06:53:45 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "53"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n\t\"success\": true,\n \"deliveryOptionId\":\"123\"\n}"
}
]
},
{
"name": "Get Delivery Options",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryOptions",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryOptions"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to check coverage for your active delivery company contracts by providing either the `orderId` or the `city` details. Follow these guidelines:\n\n**Important:**\n\n- Do not include both `orderId` and `city` in the same request, as this will result in an error.\n \n- Ensure your request contains only one of these parameters to proceed successfully.\n \n\n**Request Parameters:**\n\n| Name | Required | **Type** | **Description** |\n| --- | --- | --- | --- |\n| city | no | string | Check coverage in the city. |\n| orderId | no | string | Check coverage for that specific order. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryOptions",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryOptions"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "d4eae5a4fbb49159a85b0764c0a0e8d5;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 02 Nov 2021 13:22:59 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "1565"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"options\": [\n {\n \"name\": \"Tam\",\n \"deliveryOptionId\": 4,\n \"integrationName\": \"tam\"\n },\n {\n \"name\": \"Aymakan\",\n \"deliveryOptionId\": 20,\n \"webhookUrl\": \"https://login.tryoto.com/shipmentStatus?token=7NhG6Fhsk8MMoLYBMmMo&dc=aymakan\"\n },\n {\n \"name\": \"Aramex\",\n \"deliveryOptionId\": 22,\n \"webhookUrl\": \"https://login.tryoto.com/shipmentStatus?token=TMcFSCSFSD3ctGpIk7wX&dc=aramex\"\n }\n ]\n}"
},
{
"name": "200-by-id",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryOptions?id=10",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryOptions"],
"query": [
{
"key": "id",
"value": "10"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "057372a7e5413d00cc3a6e2ef93df252"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 30 Jan 2022 07:23:38 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "174"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"options\": [\n {\n \"name\": \"Clex \",\n \"deliveryOptionId\": 10,\n \"dcName\": \"Clex \",\n \"webhookUrl\": \"https://login.tryoto.com/shipmentStatus?token=VBV78cyfmn9mXDHYUK1Z&dc=clex\"\n }\n ]\n}"
},
{
"name": "200-by city",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}/rest/v2/getDeliveryOptions?city=Riyadh",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getDeliveryOptions"],
"query": [
{
"key": "city",
"value": "Riyadh"
}
]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": true,\r\n \"options\": [\r\n {\r\n \"name\": \"Esnad Express\",\r\n \"deliveryOptionId\": 679412,\r\n \"integrationName\": \"esnad\",\r\n \"dcName\": \"Esnad Express\"\r\n },\r\n {\r\n \"name\": \"Tam DC\",\r\n \"deliveryOptionId\": 679312,\r\n \"integrationName\": \"tam\",\r\n \"dcName\": \"Tam\"\r\n },\r\n {\r\n \"name\": \"naqel\",\r\n \"deliveryOptionId\": 644612,\r\n \"integrationName\": \"naqel\",\r\n \"dcName\": \"Naqel express\"\r\n },\r\n {\r\n \"name\": \"jtexpress\",\r\n \"deliveryOptionId\": 631112,\r\n \"integrationName\": \"jtexpress\",\r\n \"dcName\": \"J&T Express\"\r\n },\r\n {\r\n \"name\": \"Spl test\",\r\n \"deliveryOptionId\": 627912,\r\n \"integrationName\": \"saudiPostV2\",\r\n \"dcName\": \"SPL V2\"\r\n }\r\n ]\r\n}"
}
]
},
{
"name": "Get Cities",
"request": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImMxNTQwYWM3MWJiOTJhYTA2OTNjODI3MTkwYWNhYmU1YjA1NWNiZWMiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoiRW50ZXJwcmlzZVBhY2thZ2UiLCJ1c2VyVHlwZSI6ImRyaXZlclVzZXIiLCJ1c2VyTmFtZSI6Ik11aGFtbWVkIE5lY2F0aSBQb2xhdCIsInVzZXJJZCI6IjI0NDI5IiwiZW1haWwiOiJtbnBAZ21haWwuY29tIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL290by1zdGFnZS1hcGkiLCJhdWQiOiJvdG8tc3RhZ2UtYXBpIiwiYXV0aF90aW1lIjoxNzAyODkzNDY2LCJ1c2VyX2lkIjoiMEs0RXhjRWphSFg1aDNRRm1uTkxrTzczaERBMiIsInN1YiI6IjBLNEV4Y0VqYUhYNWgzUUZtbk5Ma083M2hEQTIiLCJpYXQiOjE3MjEyMjE2NjcsImV4cCI6MTcyMTIyNTI2NywiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbIm1ucEBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9fQ.on3ZFVUA6ys0dAcJZPIAsuBCJ-t7CVkQAhd4Pn7pW0i0H_uKCmfjyC4Yy4UhHrm3_oeRRq4_RmPMhDffwZOfT4913CSwzMeBuL1uJVAh0mytuOhegC-Tid84QAg84LFrjutnSfJYC618Cd1c5pzM5z5LVFnIyxxVzMISWKF8cvaKwJ4UnheuTpK0ps0P9UM09ExWkoJi5gP1T1aS8xOnW23QlegG16EMvOzzArbtp-8sRm1UtqDsSE6w1fMzxLZGOB6Zv6ofuNdjwTDRd0wFK1aF93vExnR84XbXUoPj9zMb-7_h9JfOafyb8BjoxmK3YQGXW1DAoh8fzqPfEdIv_g",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"country\": \"SA\",\r\n \"perPage\": 10,\r\n \"page\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getCities",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getCities"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint is used to retrieve a list of cities of a given country.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| country | yes | string | The country for which cities are to be retrieved. |\n| perPage | no | integer | The number of cities to be displayed per page. Default value is 100, max value is 500. |\n| page | no | integer | The page number for pagination. |\n\nExample Response:\n\n``` json\n{\n \"getCities\": {\n \"totalCount\": 1,\n \"perPage\": 1,\n \"Cities\": [\n {\n \"name\": \"Riyadh\"\n }\n ]\n }\n}\n\n ```"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"country\": \"SA\",\r\n \"perPage\": 400,\r\n \"page\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/getCities",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "getCities"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 17 Jul 2024 15:13:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "8672"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"getCities\": {\n \"totalCount\": 704,\n \"perPage\": 400,\n \"Cities\": [\n {\n \"name\": \"Aba Alworood\"\n },\n {\n \"name\": \"Abayt\"\n },\n {\n \"name\": \"Abha\"\n },\n {\n \"name\": \"Abha Manhal\"\n },\n {\n \"name\": \"Abiar Al Mashi\"\n },\n {\n \"name\": \"Abil\"\n },\n {\n \"name\": \"Abu Ajram\"\n },\n {\n \"name\": \"Abu Al Arj\"\n },\n {\n \"name\": \"Abu Arish\"\n },\n {\n \"name\": \"Abu Arradeef\"\n },\n {\n \"name\": \"Abu Dhiba\"\n },\n {\n \"name\": \"Abu Hadriyah\"\n },\n {\n \"name\": \"Abu Hajar\"\n },\n {\n \"name\": \"Abu Muloh\"\n },\n {\n \"name\": \"Abu Rakah\"\n },\n {\n \"name\": \"Abu Rakh\"\n },\n {\n \"name\": \"Ad Dahinah\"\n },\n {\n \"name\": \"Ad Dalfaah\"\n },\n {\n \"name\": \"Ad Dilam\"\n },\n {\n \"name\": \"Ad Diriyah\"\n },\n {\n \"name\": \"Ad Dubaiyah\"\n },\n {\n \"name\": \"Ad Dumayriyah\"\n },\n {\n \"name\": \"Ad Duwadimi\"\n },\n {\n \"name\": \"Addayer\"\n },\n {\n \"name\": \"Adham\"\n },\n {\n \"name\": \"Afif\"\n },\n {\n \"name\": \"Afraa\"\n },\n {\n \"name\": \"Ahad Al Musarihah\"\n },\n {\n \"name\": \"Ahad Bani Zayd\"\n },\n {\n \"name\": \"Ahad Rifaydah\"\n },\n {\n \"name\": \"Ain Al Nakhal\"\n },\n {\n \"name\": \"Ain Dar\"\n },\n {\n \"name\": \"Airj\"\n },\n {\n \"name\": \"Al Aarid\"\n },\n {\n \"name\": \"Al Abar\"\n },\n {\n \"name\": \"Al Abyar\"\n },\n {\n \"name\": \"Al Adari\"\n },\n {\n \"name\": \"Al Adhiriyah\"\n },\n {\n \"name\": \"Al Aflaj (Layla)\"\n },\n {\n \"name\": \"Al Ahmar\"\n },\n {\n \"name\": \"Al Ahmar-Yanbu\"\n },\n {\n \"name\": \"Al Ahsaa\"\n },\n {\n \"name\": \"Al Ais\"\n },\n {\n \"name\": \"Al Aithmah\"\n },\n {\n \"name\": \"Al Ajfar\"\n },\n {\n \"name\": \"Al Ama ir\"\n },\n {\n \"name\": \"Al Amaaria\"\n },\n {\n \"name\": \"Al Amajiyah\"\n },\n {\n \"name\": \"Al Amar\"\n },\n {\n \"name\": \"Al Amlah\"\n },\n {\n \"name\": \"Al Ammarah\"\n },\n {\n \"name\": \"Al Amoah\"\n },\n {\n \"name\": \"AL Andalus\"\n },\n {\n \"name\": \"Al Aqiqah\"\n },\n {\n \"name\": \"Al Aqool\"\n },\n {\n \"name\": \"Al Aradiyah\"\n },\n {\n \"name\": \"Al Araq\"\n },\n {\n \"name\": \"Al Ardah\"\n },\n {\n \"name\": \"Al Ardiyat\"\n },\n {\n \"name\": \"Al Arfaa \"\n },\n {\n \"name\": \"Al Arin\"\n },\n {\n \"name\": \"Al Arja\"\n },\n {\n \"name\": \"Al Aroos\"\n },\n {\n \"name\": \"Al Artawi\"\n },\n {\n \"name\": \"Al Asad\"\n },\n {\n \"name\": \"Al Aseelh\"\n },\n {\n \"name\": \"Al Ataya\"\n },\n {\n \"name\": \"Al Atheeb\"\n },\n {\n \"name\": \"Al Atif\"\n },\n {\n \"name\": \"Al Awamer\"\n },\n {\n \"name\": \"Al Bada\"\n },\n {\n \"name\": \"Al Badai\"\n },\n {\n \"name\": \"Al Badie Al Shamali \"\n },\n {\n \"name\": \"Al Baha\"\n },\n {\n \"name\": \"Al Bahah Region\"\n },\n {\n \"name\": \"Al Baheem\"\n },\n {\n \"name\": \"Al Bashayer\"\n },\n {\n \"name\": \"AL BASR\"\n },\n {\n \"name\": \"Al Batra\"\n },\n {\n \"name\": \"Al Bijadyah\"\n },\n {\n \"name\": \"Al Bikreyah\"\n },\n {\n \"name\": \"Al Bir\"\n },\n {\n \"name\": \"Al Bukayriyah\"\n },\n {\n \"name\": \"Al Butayn\"\n },\n {\n \"name\": \"Al Dalemya\"\n },\n {\n \"name\": \"Al Dhabyah\"\n },\n {\n \"name\": \"Al Dhahreyah\"\n },\n {\n \"name\": \"Al Dheelah\"\n },\n {\n \"name\": \"AL DUGHAIMIYAH\"\n },\n {\n \"name\": \"Al Dulaymiyah\"\n },\n {\n \"name\": \"Al Fagali\"\n },\n {\n \"name\": \"Al Fara\"\n },\n {\n \"name\": \"Al Farshah\"\n },\n {\n \"name\": \"Al Fatiha\"\n },\n {\n \"name\": \"Al Fawwarah\"\n },\n {\n \"name\": \"Al Furaysh\"\n },\n {\n \"name\": \"Al Fuwaileq\"\n },\n {\n \"name\": \"Al Gafrat\"\n },\n {\n \"name\": \"Al Gamri\"\n },\n {\n \"name\": \"Al Gandla\"\n },\n {\n \"name\": \"Al Gharif \"\n },\n {\n \"name\": \"Al Ghat\"\n },\n {\n \"name\": \"Al Habjeia\"\n },\n {\n \"name\": \"Al Haddar\"\n },\n {\n \"name\": \"Al Hadror\"\n },\n {\n \"name\": \"Al Haeer\"\n },\n {\n \"name\": \"Al Haith\"\n },\n {\n \"name\": \"Al Haqu\"\n },\n {\n \"name\": \"Al Harara\"\n },\n {\n \"name\": \"Al Hariq\"\n },\n {\n \"name\": \"Al Harth\"\n },\n {\n \"name\": \"Al Hayathem\"\n },\n {\n \"name\": \"Al Hayeet\"\n },\n {\n \"name\": \"Al Hazim\"\n },\n {\n \"name\": \"Al Hazmi\"\n },\n {\n \"name\": \"Al Henayah\"\n },\n {\n \"name\": \"Al Heno\"\n },\n {\n \"name\": \"Al Hifah\"\n },\n {\n \"name\": \"Al Hijf\"\n },\n {\n \"name\": \"Al Hilaliyah\"\n },\n {\n \"name\": \"Al Hinnah\"\n },\n {\n \"name\": \"Al huda\"\n },\n {\n \"name\": \"Al Hudud Al Shamaliyah\"\n },\n {\n \"name\": \"Al Hufayr\"\n },\n {\n \"name\": \"Al Hufayyirah\"\n },\n {\n \"name\": \"Al Hufuf\"\n },\n {\n \"name\": \"Al Hulayfah As Sufla\"\n },\n {\n \"name\": \"Al Hulwah\"\n },\n {\n \"name\": \"Al Husayni\"\n },\n {\n \"name\": \"Al Husayniyah\"\n },\n {\n \"name\": \"Al Husayy\"\n },\n {\n \"name\": \"Al Husima\"\n },\n {\n \"name\": \"Al Huwaya east\"\n },\n {\n \"name\": \"Al Idabi\"\n },\n {\n \"name\": \"Al JABRIYAH\"\n },\n {\n \"name\": \"Al Jafr\"\n },\n {\n \"name\": \"Al Jaradiyah\"\n },\n {\n \"name\": \"Al Jarf\"\n },\n {\n \"name\": \"Al Jarn\"\n },\n {\n \"name\": \"Al Jawf Region\"\n },\n {\n \"name\": \"Al Jawwah\"\n },\n {\n \"name\": \"Al Jifah\"\n },\n {\n \"name\": \"Al Jithamiyah\"\n },\n {\n \"name\": \"Al Jubail\"\n },\n {\n \"name\": \"Al Jubailah\"\n },\n {\n \"name\": \"Al Jumum\"\n },\n {\n \"name\": \"Al kadami\"\n },\n {\n \"name\": \"Al Kadarah\"\n },\n {\n \"name\": \"Al Kamil\"\n },\n {\n \"name\": \"Al Khafji\"\n },\n {\n \"name\": \"Al Khalaf\"\n },\n {\n \"name\": \"Al Khaniq\"\n },\n {\n \"name\": \"Al Kharj\"\n },\n {\n \"name\": \"Al Kharkhir\"\n },\n {\n \"name\": \"Al Khashabiyah\"\n },\n {\n \"name\": \"Al Khasiybahi\"\n },\n {\n \"name\": \"Al Khitah\"\n },\n {\n \"name\": \"Al khoba\"\n },\n {\n \"name\": \"Al Khubar\"\n },\n {\n \"name\": \"Al Khuffiyah\"\n },\n {\n \"name\": \"Al khuraybah\"\n },\n {\n \"name\": \"Al Khuraytah\"\n },\n {\n \"name\": \"Al Khurmah\"\n },\n {\n \"name\": \"Al Khushaybi\"\n },\n {\n \"name\": \"Al Lahien\"\n },\n {\n \"name\": \"Al Laqayit\"\n },\n {\n \"name\": \"Al Lsawiyah\"\n },\n {\n \"name\": \"Al Ma`ashabah\"\n },\n {\n \"name\": \"Al Mada\"\n },\n {\n \"name\": \"Al Madaya\"\n },\n {\n \"name\": \"Al Madha\"\n },\n {\n \"name\": \"Al Madinah Region\"\n },\n {\n \"name\": \"AL MAHANI\"\n },\n {\n \"name\": \"Al Mahd\"\n },\n {\n \"name\": \"Al Majardah\"\n },\n {\n \"name\": \"Al Majmaah\"\n },\n {\n \"name\": \"AL MALIDA\"\n },\n {\n \"name\": \"Al Marameh\"\n },\n {\n \"name\": \"Al Markaz\"\n },\n {\n \"name\": \"Al Marmuthah\"\n },\n {\n \"name\": \"Al Marooj\"\n },\n {\n \"name\": \"Al Masgi\"\n },\n {\n \"name\": \"Al Mayyah\"\n },\n {\n \"name\": \"Al Midhnab\"\n },\n {\n \"name\": \"Al Midrij\"\n },\n {\n \"name\": \"Al Mishaliah\"\n },\n {\n \"name\": \"Al Mothalath\"\n },\n {\n \"name\": \"Al Mozvin\"\n },\n {\n \"name\": \"Al Mubarakah\"\n },\n {\n \"name\": \"Al Mudayyih\"\n },\n {\n \"name\": \"Al Mukhwah\"\n },\n {\n \"name\": \"Al Mulaylih\"\n },\n {\n \"name\": \"Al Muntashar\"\n },\n {\n \"name\": \"Al Musayjid\"\n },\n {\n \"name\": \"Al Muwaylih\"\n },\n {\n \"name\": \"Al Muzahimiyah\"\n },\n {\n \"name\": \"Al Nabah\"\n },\n {\n \"name\": \"Al Nuzha\"\n },\n {\n \"name\": \"Al Ogam\"\n },\n {\n \"name\": \"Al Qaa\"\n },\n {\n \"name\": \"Al Qaid\"\n },\n {\n \"name\": \"Al Qaied\"\n },\n {\n \"name\": \"Al Qarin\"\n },\n {\n \"name\": \"Al Qarinah\"\n },\n {\n \"name\": \"Al Qassim Region\"\n },\n {\n \"name\": \"Al Qatif\"\n },\n {\n \"name\": \"Al Qeddeh\"\n },\n {\n \"name\": \"Al Qirawan\"\n },\n {\n \"name\": \"Al qowarah\"\n },\n {\n \"name\": \"Al Qulayyib\"\n },\n {\n \"name\": \"Al Qunfidhah\"\n },\n {\n \"name\": \"Al Qurainah\"\n },\n {\n \"name\": \"Al Qurayyat\"\n },\n {\n \"name\": \"AL QURESHIYAT\"\n },\n {\n \"name\": \"Al Rafaeya'a\"\n },\n {\n \"name\": \"Al Rafaie\"\n },\n {\n \"name\": \"Al Rathaya\"\n },\n {\n \"name\": \"Al Rayis\"\n },\n {\n \"name\": \"Al Reeth\"\n },\n {\n \"name\": \"Al Ruqi\"\n },\n {\n \"name\": \"Al Sahalil\"\n },\n {\n \"name\": \"Al Salamah\"\n },\n {\n \"name\": \"AL SAYL ALKHABIR\"\n },\n {\n \"name\": \"AL SAYL ALSAGHIR\"\n },\n {\n \"name\": \"Al Shatt\"\n },\n {\n \"name\": \"Al Shegrah\"\n },\n {\n \"name\": \"Al Shehiyah\"\n },\n {\n \"name\": \"Al Sheqiqah\"\n },\n {\n \"name\": \"Al Shlayil\"\n },\n {\n \"name\": \"Al Shoqiyah\"\n },\n {\n \"name\": \"Al Shuaba\"\n },\n {\n \"name\": \"Al Sih\"\n },\n {\n \"name\": \"Al Subaykhah\"\n },\n {\n \"name\": \"Al Sulaimi\"\n },\n {\n \"name\": \"Al tanumah\"\n },\n {\n \"name\": \"Al Taraf\"\n },\n {\n \"name\": \"Al Theniah\"\n },\n {\n \"name\": \"Al Torkiyah\"\n },\n {\n \"name\": \"Al Twaitheer\"\n },\n {\n \"name\": \"Al Udayd\"\n },\n {\n \"name\": \"Al Uferiah\"\n },\n {\n \"name\": \"Al Uwayqilah\"\n },\n {\n \"name\": \"Al Waddean\"\n },\n {\n \"name\": \"Al Wajh\"\n },\n {\n \"name\": \"Al Wannan\"\n },\n {\n \"name\": \"Al Wasayta\"\n },\n {\n \"name\": \"Al-Batna\"\n },\n {\n \"name\": \"Al-halaa\"\n },\n {\n \"name\": \"AL-JUAYMAH\"\n },\n {\n \"name\": \"Al-Matan\"\n },\n {\n \"name\": \"Al-MNSALA\"\n },\n {\n \"name\": \"Al-Nasifa\"\n },\n {\n \"name\": \"Al-Umran\"\n },\n {\n \"name\": \"Al-Wozeyh\"\n },\n {\n \"name\": \"Alabadilah\"\n },\n {\n \"name\": \"Alarjeen\"\n },\n {\n \"name\": \"Alasilan\"\n },\n {\n \"name\": \"Alearduh\"\n },\n {\n \"name\": \"Algayed\"\n },\n {\n \"name\": \"Alhada\"\n },\n {\n \"name\": \"Alhayma\"\n },\n {\n \"name\": \"Aliland\"\n },\n {\n \"name\": \"AlJanadria\"\n },\n {\n \"name\": \"Alkhazzan\"\n },\n {\n \"name\": \"AlKhhafah\"\n },\n {\n \"name\": \"Almazef\"\n },\n {\n \"name\": \"Almutayrifi\"\n },\n {\n \"name\": \"Almuzayri\"\n },\n {\n \"name\": \"Alnabhanya\"\n },\n {\n \"name\": \"Alqabil\"\n },\n {\n \"name\": \"Alquaba\"\n },\n {\n \"name\": \"AlQudaih\"\n },\n {\n \"name\": \"Alqurra\"\n },\n {\n \"name\": \"Alshahili\"\n },\n {\n \"name\": \"Alshihyah\"\n },\n {\n \"name\": \"Alshuqayri\"\n },\n {\n \"name\": \"Alshwaaq\"\n },\n {\n \"name\": \"Alsilaa\"\n },\n {\n \"name\": \"Alsulmania\"\n },\n {\n \"name\": \"Alturfiyah\"\n },\n {\n \"name\": \"Alwasqah\"\n },\n {\n \"name\": \"Alyutamah\"\n },\n {\n \"name\": \"Amaaer Ben Sana'a\"\n },\n {\n \"name\": \"Amaq\"\n },\n {\n \"name\": \"An Nabiyah\"\n },\n {\n \"name\": \"An Nabk Abu Qasr\"\n },\n {\n \"name\": \"An nabqiyyah\"\n },\n {\n \"name\": \"An Nafiah\"\n },\n {\n \"name\": \"An Nasiriyah\"\n },\n {\n \"name\": \"An Nawwariyyah\"\n },\n {\n \"name\": \"An Nazayim\"\n },\n {\n \"name\": \"An Nuayriyah\"\n },\n {\n \"name\": \"An Nuqrah\"\n },\n {\n \"name\": \"Aqiq\"\n },\n {\n \"name\": \"Ar Radifah\"\n },\n {\n \"name\": \"Ar Rafi'ah\"\n },\n {\n \"name\": \"Ar Rafiah\"\n },\n {\n \"name\": \"Ar Rass\"\n },\n {\n \"name\": \"Ar Rawdah \"\n },\n {\n \"name\": \"AR RAYN\"\n },\n {\n \"name\": \"Ar Rishawiyah\"\n },\n {\n \"name\": \"Arafa\"\n },\n {\n \"name\": \"Arar\"\n },\n {\n \"name\": \"Artawiah\"\n },\n {\n \"name\": \"As Sahwah\"\n },\n {\n \"name\": \"As Sam'uriyah\"\n },\n {\n \"name\": \"As Shamli\"\n },\n {\n \"name\": \"As Sihaf\"\n },\n {\n \"name\": \"As Sulaimaniyah\"\n },\n {\n \"name\": \"As Sulayyil\"\n },\n {\n \"name\": \"As Sulubiayh\"\n },\n {\n \"name\": \"Asbtar\"\n },\n {\n \"name\": \"asdadadeaed\"\n },\n {\n \"name\": \"asdasd\"\n },\n {\n \"name\": \"asdasdrertyr\"\n },\n {\n \"name\": \"asdqtrawqew\"\n },\n {\n \"name\": \"Asfan\"\n },\n {\n \"name\": \"Ash Shaara\"\n },\n {\n \"name\": \"Ash Shananah\"\n },\n {\n \"name\": \"Ash Shimasiyah\"\n },\n {\n \"name\": \"Ash Shinan\"\n },\n {\n \"name\": \"Ash Shumaysi\"\n },\n {\n \"name\": \"Ash Shuqaiq\"\n },\n {\n \"name\": \"Ash Shuqrah\"\n },\n {\n \"name\": \"Asheerah Sudayer\"\n },\n {\n \"name\": \"Asir\"\n },\n {\n \"name\": \"Asir Region\"\n },\n {\n \"name\": \"Assadawi\"\n },\n {\n \"name\": \"Assalmanyah\"\n },\n {\n \"name\": \"Assiyah\"\n },\n {\n \"name\": \"Asuwayq\"\n },\n {\n \"name\": \"At Tan'Im\"\n },\n {\n \"name\": \"At Tiraq\"\n },\n {\n \"name\": \"At Tuwal\"\n },\n {\n \"name\": \"At Tuwayr\"\n },\n {\n \"name\": \"Atawleh\"\n },\n {\n \"name\": \"Ath Thamiriyah\"\n },\n {\n \"name\": \"Ath Thybiyah\"\n },\n {\n \"name\": \"Awamiah\"\n },\n {\n \"name\": \"Awdah Sudayer\"\n },\n {\n \"name\": \"Ayn Fuhayd\"\n },\n {\n \"name\": \"Az Zughayn\"\n },\n {\n \"name\": \"Az Zulfi\"\n },\n {\n \"name\": \"Badar Hunain\"\n },\n {\n \"name\": \"Badr\"\n },\n {\n \"name\": \"Badr Al Janoub\"\n },\n {\n \"name\": \"Bahara\"\n },\n {\n \"name\": \"Bahr Abu Sukaynah\"\n },\n {\n \"name\": \"Bahrain Causeway\"\n },\n {\n \"name\": \"Bahrat Al Moujoud\"\n },\n {\n \"name\": \"Balahmar\"\n },\n {\n \"name\": \"Baljurashi\"\n },\n {\n \"name\": \"Balqarn\"\n },\n {\n \"name\": \"Banban\"\n },\n {\n \"name\": \"Bani Hamim\"\n },\n {\n \"name\": \"Bani Hasan\"\n },\n {\n \"name\": \"Bani Malek\"\n },\n {\n \"name\": \"Baqa Ash Sharqiyah\"\n },\n {\n \"name\": \"Baqaa\"\n },\n {\n \"name\": \"Bareq\"\n },\n {\n \"name\": \"Batha\"\n },\n {\n \"name\": \"Bawathil\"\n },\n {\n \"name\": \"Baynah\"\n },\n {\n \"name\": \"Baysh\"\n },\n {\n \"name\": \"Billasmar\"\n },\n {\n \"name\": \"Bin Aqeel Palace\"\n },\n {\n \"name\": \"Bir Bin Harmas\"\n },\n {\n \"name\": \"Birk\"\n },\n {\n \"name\": \"Bishah\"\n },\n {\n \"name\": \"Buqayq\"\n },\n {\n \"name\": \"Buraydah\"\n },\n {\n \"name\": \"Daelim\"\n },\n {\n \"name\": \"Dahu\"\n },\n {\n \"name\": \"Damad\"\n },\n {\n \"name\": \"Dammam\"\n },\n {\n \"name\": \"Darb\"\n },\n {\n \"name\": \"Dariyah\"\n },\n {\n \"name\": \"Dawmat Al Jandal\"\n },\n {\n \"name\": \"dayida\"\n },\n {\n \"name\": \"Deraab\"\n },\n {\n \"name\": \"Dhahban\"\n },\n {\n \"name\": \"Dhahran\"\n },\n {\n \"name\": \"Dhahran Al Janoub\"\n },\n {\n \"name\": \"DHALAM\"\n },\n {\n \"name\": \"Dhurma\"\n },\n {\n \"name\": \"Duba\"\n },\n {\n \"name\": \"DUBAY'AH\"\n },\n {\n \"name\": \"Duhknah\"\n },\n {\n \"name\": \"Dulay Rashid\"\n },\n {\n \"name\": \"Dulayhan\"\n },\n {\n \"name\": \"dummy\"\n },\n {\n \"name\": \"Eaqabat shiear\"\n },\n {\n \"name\": \"Eastern Province\"\n },\n {\n \"name\": \"Eastern Region\"\n },\n {\n \"name\": \"Eayan dar aljadida\"\n },\n {\n \"name\": \"Eayan dar alqadima\"\n },\n {\n \"name\": \"Edadh\"\n },\n {\n \"name\": \"Either\"\n },\n {\n \"name\": \"El-Ebva\"\n },\n {\n \"name\": \"Eshirah\"\n }\n ]\n }\n}"
},
{
"name": "409 country null",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \r\n \"perPage\": 1000,\r\n \"page\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getCities",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getCities"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 17 Jul 2024 15:00:18 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "46"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"errorMsg\": \"country is null\"\n}"
}
]
}
]
},
{
"name": "Pickup Locations",
"item": [
{
"name": "Create Pickup Location",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-02\",\r\n \"name\": \"Location-02 Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"country\":\"SA\",\r\n \"postcode\": \"12345\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createPickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createPickupLocation"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to define and register a new pickup location within the system. By specifying the location details, you can expand your network of pickup points, improving logistics and delivery workflows.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | yes | string | Name of the pickup location |\n| type | no | string | You can enter these values: `branch`, `warehouse`. <br>Branch can only be used by enterprise and marketplace packages |\n| code | yes | string | Code of the pickup location |\n| mobile | yes | string | Mobile number of the pickup location |\n| lat | no | number | Latitude, \\*if not exist orders may not assigned to pickupLocations automatically |\n| lon | no | number | Longitude, \\* if not exist orders may not assigned to pickupLocations automatically |\n| city | yes | string | City name of the pickup location |\n| country | yes | string | Country ISO2 code \"SA\",\"AE\" etc. |\n| postcode | no | string | Postal code of the pickup location |\n| address | yes | string | Address of the pickup location |\n| district | no | string | The district or area where the location is situated |\n| state | no | string | The state or province where the pickup location is located |\n| street | no | string | The street address of the pickup location |\n| contactName | yes | string | If not exists you may not create shipments with some delivery companies |\n| contactEmail | yes | string | In format of [[email protected]](https://) |\n| servingRadius | no | number | Serving radius of branch in KM |\n| brandName | no | string | Store brand name which this location belongs to. |\n| status | no | string | Status of the pickup location(active, inactive) |"
},
"response": [
{
"name": "200 warehouse",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-01\",\r\n \"name\": \"Location Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"district\":\"Al Khalidiyyah\",\r\n \"street\":\"Al Janubiyyah\",\r\n \"state\":\"Eastern Province\",\r\n \"country\":\"SA\",\r\n \"postcode\": \"12345\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller\",\r\n \"status\": \"active\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/createPickupLocation",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "createPickupLocation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "670ef00be5ba7a8b959e8e6c913be189;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 02 Nov 2021 14:19:10 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "71"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"warhouseId\": \"123\",\n \"pickupLocationCode\":\"code-01\",\n \"success\": true,\n \"message\": \"warhouse has been created\"\n}"
},
{
"name": "200 branch",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"branch\",\r\n \"code\": \"code-01\",\r\n \"name\": \"Location Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"district\":\"Al Khalidiyyah\",\r\n \"street\":\"Al Janubiyyah\",\r\n \"state\":\"Eastern Province\",\r\n \"country\":\"SA\",\r\n \"postcode\": \"12345\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller\",\r\n \"status\": \"active\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createPickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createPickupLocation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "670ef00be5ba7a8b959e8e6c913be189;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 02 Nov 2021 14:19:10 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "71"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"warhouseId\": \"123\",\n \"pickupLocationCode\":\"code-01\",\n \"success\": true,\n \"message\": \"warhouse has been created\"\n}"
},
{
"name": "200-exist",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-01\",\r\n \"name\": \"Location Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"district\":\"Al Khalidiyyah\",\r\n \"street\":\"Al Janubiyyah\",\r\n \"state\":\"Eastern Province\",\r\n \"country\":\"SA\",\r\n \"postcode\": \"12345\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller\",\r\n \"status\": \"active\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createPickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createPickupLocation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "dc5da99dde98c1bbeb822597dd7958fc"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 02 Nov 2021 14:29:23 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "74"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"warhouseId\": \"123\",\n \"pickupLocationCode\":\"code-01\",\n \"success\": true,\n \"message\": \"warhouse has already exist\"\n}"
}
]
},
{
"name": "Update Pickup Location",
"event": [
{
"listen": "test",
"script": {
"exec": [
"\r",
"// var jsonData = pm.response.json();\r",
"// console.log(\"branchId\"+jsonData.branchId);\r",
"\r",
"\r",
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-02\",\r\n \"name\": \"Location-02 Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"district\":\"Latifah Manaf\",\r\n \"street\":\"Long Street\",\r\n \"state\":\"Eastern Province\",\r\n \"country\": \"SA\",\r\n \"postcode\": \"77777\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller 2\",\r\n \"status\":\"active\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePickupLocation"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to modify the details of your existing pickup locations efficiently. This endpoint provides a streamlined way to ensure that your pickup location information remains accurate and up to date, enabling smooth and reliable operations.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | yes | string | Name of the pickup location |\n| type | no | string | You can enter these values: `branch`, `warehouse`. <br>Branch can only be used by enterprise and marketplace packages |\n| code | yes | string | Code of the pickup location |\n| mobile | yes | string | Mobile number of the pickup location |\n| lat | no | number | Latitude, \\*if not exist orders may not assigned to pickupLocations automatically |\n| lon | no | number | Longitude, \\* if not exist orders may not assigned to pickupLocations automatically |\n| city | yes | string | City name of the pickup location |\n| country | yes | string | Country ISO2 code \"SA\",\"AE\" etc. |\n| postcode | no | string | Postal code of the pickup location |\n| address | yes | string | Address of the pickup location |\n| district | no | string | The district or area where the location is situated |\n| state | no | string | The state or province where the pickup location is located |\n| street | no | string | The street address of the pickup location |\n| contactName | yes | string | If not exists you may not create shipments with some delivery companies |\n| contactEmail | yes | string | In format of [[email protected]](https://) |\n| servingRadius | no | number | Serving radius of branch in KM |\n| brandName | no | string | Store brand name which this location belongs to. |\n| status | no | string | Status of the pickup location(active, inactive) |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-02\",\r\n \"name\": \"Location-02 Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"postcode\": \"77777\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller 2\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePickupLocation"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "7b588b60963af03b8c9917c6dcec1da5;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 25 Oct 2021 15:15:59 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "34"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"branchId\": \"1878\",\n \"pickupLocationCode\": \"code-02\",\n \"success\": true\n}"
},
{
"name": "400 Bad Request",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"warehouse\",\r\n \"code\": \"code-02\",\r\n \"name\": \"Location-02 Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"postcode\": \"77777\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller 2\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePickupLocation"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "e2bd74db5e3f67597b8346cc21d76614;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 25 Oct 2021 15:27:24 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "87"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"errorCode\": 5,\n \"errorMsg\": \"Code, Mobile and Location must be provided\"\n}"
},
{
"name": "404",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"branch\",\r\n \"code\": \"code-02\",\r\n \"name\": \"Location-02 Name\",\r\n \"mobile\": \"555888777\",\r\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\r\n \"contactName\": \"Test Contact\",\r\n \"contactEmail\": \"Test Email\",\r\n \"lat\": \"26.001\",\r\n \"lon\": \"50.001\",\r\n \"city\": \"Dammam\",\r\n \"postcode\": \"77777\",\r\n \"servingRadius\": \"10\",\r\n \"brandName\": \"Example Seller 2\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePickupLocation",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePickupLocation"]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "a3e8bb4c874420c2b88394045a067463;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Sun, 16 Jan 2022 10:45:05 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "56"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1070\",\n \"otoErrorMessage\":\"Pickup location code is missing or invalid\"\n}"
}
]
},
{
"name": "Get Pickup Location List",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getPickupLocationList?minDate=2024-08-01&maxDate=2024-08-05&status=active",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getPickupLocationList"],
"query": [
{
"key": "minDate",
"value": "2024-08-01"
},
{
"key": "maxDate",
"value": "2024-08-05"
},
{
"key": "status",
"value": "active"
}
]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint enables you to retrieve a comprehensive list of pickup locations by specifying a date range and status. This endpoint provides an efficient way to filter and access relevant pickup location data, ensuring streamlined tracking and management.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| minDate | no | date | Starting Pickup location create date in \"yyyy-mm-dd\" format. (e.g. \"2024-08-01\") |\n| maxDate | no | date | Ending Pickup location create date in \"yyyy-mm-dd\" format. (e.g. \"2024-08-05\") |\n| status | no | string | Status of the pickup location(active, inactive) |\n\n**Response Body**\n\nThe response includes a boolean flag \"success\" indicating the success of the request, along with arrays of \"warehouses\" and \"branches\" containing details of pickup locations including their codes, addresses, contact information, geographical coordinates, and other relevant attributes.\n\n``` json\n{\n \"success\": true,\n \"warehouses\": [\n {\n \"code\": \"code-999\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 17051,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.001\n },\n {\n \"code\": \"code-95\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 17052,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.001\n }\n ],\n \"branches\": [\n {\n \"code\": \"code-96\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location-02 Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 18203,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.002\n }\n ]\n}\n\n ```"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImMxNTQwYWM3MWJiOTJhYTA2OTNjODI3MTkwYWNhYmU1YjA1NWNiZWMiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoiRW50ZXJwcmlzZVBhY2thZ2UiLCJ1c2VyVHlwZSI6ImRyaXZlclVzZXIiLCJ1c2VyTmFtZSI6Ik11aGFtbWVkIE5lY2F0aSBQb2xhdCIsInVzZXJJZCI6IjI0NDI5IiwiZW1haWwiOiJtbnBAZ21haWwuY29tIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL290by1zdGFnZS1hcGkiLCJhdWQiOiJvdG8tc3RhZ2UtYXBpIiwiYXV0aF90aW1lIjoxNzAyODkzNDY2LCJ1c2VyX2lkIjoiMEs0RXhjRWphSFg1aDNRRm1uTkxrTzczaERBMiIsInN1YiI6IjBLNEV4Y0VqYUhYNWgzUUZtbk5Ma083M2hEQTIiLCJpYXQiOjE3MjEyMjE2NjcsImV4cCI6MTcyMTIyNTI2NywiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbIm1ucEBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9fQ.on3ZFVUA6ys0dAcJZPIAsuBCJ-t7CVkQAhd4Pn7pW0i0H_uKCmfjyC4Yy4UhHrm3_oeRRq4_RmPMhDffwZOfT4913CSwzMeBuL1uJVAh0mytuOhegC-Tid84QAg84LFrjutnSfJYC618Cd1c5pzM5z5LVFnIyxxVzMISWKF8cvaKwJ4UnheuTpK0ps0P9UM09ExWkoJi5gP1T1aS8xOnW23QlegG16EMvOzzArbtp-8sRm1UtqDsSE6w1fMzxLZGOB6Zv6ofuNdjwTDRd0wFK1aF93vExnR84XbXUoPj9zMb-7_h9JfOafyb8BjoxmK3YQGXW1DAoh8fzqPfEdIv_g",
"type": "text"
}
],
"url": {
"raw": "https://api.tryoto.com/rest/v2/getPickupLocationList",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "getPickupLocationList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 04 Aug 2024 14:58:18 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "819"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warehouses\": [\n {\n \"code\": \"code-999\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 17051,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.001\n },\n {\n \"code\": \"code-95\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 17052,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.001\n }\n ],\n \"branches\": [\n {\n \"code\": \"code-96\",\n \"address\": \"Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225\",\n \"contactEmail\": \"Test Email\",\n \"city\": \"Dammam\",\n \"name\": \"Location-02 Name\",\n \"contactPerson\": \"Test Contact\",\n \"lon\": 50.001,\n \"id\": 18203,\n \"contactPhone\": \"555888777\",\n \"lat\": 26.002\n }\n ]\n}"
},
{
"name": "400 Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImMxNTQwYWM3MWJiOTJhYTA2OTNjODI3MTkwYWNhYmU1YjA1NWNiZWMiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoiRW50ZXJwcmlzZVBhY2thZ2UiLCJ1c2VyVHlwZSI6ImRyaXZlclVzZXIiLCJ1c2VyTmFtZSI6Ik11aGFtbWVkIE5lY2F0aSBQb2xhdCIsInVzZXJJZCI6IjI0NDI5IiwiZW1haWwiOiJtbnBAZ21haWwuY29tIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL290by1zdGFnZS1hcGkiLCJhdWQiOiJvdG8tc3RhZ2UtYXBpIiwiYXV0aF90aW1lIjoxNzAyODkzNDY2LCJ1c2VyX2lkIjoiMEs0RXhjRWphSFg1aDNRRm1uTkxrTzczaERBMiIsInN1YiI6IjBLNEV4Y0VqYUhYNWgzUUZtbk5Ma083M2hEQTIiLCJpYXQiOjE3MjEyMjE2NjcsImV4cCI6MTcyMTIyNTI2NywiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbIm1ucEBnbWFpbC5jb20iXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwYXNzd29yZCJ9fQ.on3ZFVUA6ys0dAcJZPIAsuBCJ-t7CVkQAhd4Pn7pW0i0H_uKCmfjyC4Yy4UhHrm3_oeRRq4_RmPMhDffwZOfT4913CSwzMeBuL1uJVAh0mytuOhegC-Tid84QAg84LFrjutnSfJYC618Cd1c5pzM5z5LVFnIyxxVzMISWKF8cvaKwJ4UnheuTpK0ps0P9UM09ExWkoJi5gP1T1aS8xOnW23QlegG16EMvOzzArbtp-8sRm1UtqDsSE6w1fMzxLZGOB6Zv6ofuNdjwTDRd0wFK1aF93vExnR84XbXUoPj9zMb-7_h9JfOafyb8BjoxmK3YQGXW1DAoh8fzqPfEdIv_g",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}{/rest/v2/getPickupLocationList",
"host": ["{{real-url}}{"],
"path": ["rest", "v2", "getPickupLocationList"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Sun, 04 Aug 2024 14:59:05 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "63"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"errorCode\": 4,\n \"errorMsg\": \"maxDate is invalid\"\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{real-url}}/rest/v2/getPickupLocationList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getPickupLocationList"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [],
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
}
]
}
]
},
{
"name": "Brands",
"item": [
{
"name": "Get List of Brands (Client Store)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/getBrandList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getBrandList"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides access to a comprehensive list of brand (client store) details. This endpoint enables users to retrieve information about brands associated with their account, including key attributes such as brand name, store identifiers, and other relevant metadata.\n\n**Request Parameters:**\n\nNo request body parameters are required for this GET request.\n\n**Response:**\n\nUpon a successful execution, the server responds with a 200 status code and a JSON object containing the following fields:\n\n- `success` (boolean) - Indicates the success status of the request.\n \n- `clientStores` (array) - An array of client store objects, each containing the following fields:\n \n - `companyId` (integer) - The ID of the company.\n \n - `storeName` (string) - The name of the store.\n \n - `ID` (integer) - The ID of the store.\n \n - `wareHouseName` (string) - The name of the warehouse.\n \n - `brandLogo` (string) - The URL of the brand logo.\n \n - `defaultWarehouseId` (integer) - The ID of the default warehouse.\n \n\nIn case of an empty response, the server still returns a 200 status code with an empty `clientStores` array."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/getBrandList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getBrandList"]
}
},
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"clientStores\": [\n {\n \"companyId\": 24772,\n \"storeName\": \"test123\",\n \"ID\": 1161,\n \"wareHouseName\": \"DefaultWH\",\n \"brandLogo\": \"https://storage.googleapis.com/download/storage/v1/b/oto-files-stage/\",\n \"defaultWarehouseId\": 16415\n }\n ]\n}"
}
]
},
{
"name": "Create Brand (Client Store)",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"storeName\": \"Brand A\",\n \"logo\": \"https://storage.googleapis.com/download/storage/v1/b/oto-files-stage/o/files%2F24772%2Fimport%2Fb58b6d41-af83-492c-a416-d4bb0d076be1.png?generation=1721804238908930&alt=media\",\n \"defaultWarehouseID\": 16415,\n \"stores\": [\n {\n \"storeName\": \"store A\",\n \"salesChannelCredentialsID\": 4512\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createBrand",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createBrand"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to add a new brand (client store) to the system. By using this endpoint, you can define and register a brand with essential details, enabling integration with various systems.\n\n**Request Parameters:**\n\n| Name | Required | **Type** | Description |\n| --- | --- | --- | --- |\n| storeName | yes | string | The name of the store |\n| logo | no | string | The logo URL of the brand |\n| defaultWarehouseID | no | integer | The ID of the default warehouse |\n| stores | no | array | An array of store objects containing the following fields |\n| storeName | no | string | The name of the store |\n| salesChannelCredentialsID | no | integer | The ID of the sales channel credentials |\n\n``` json\n{\n \"success\": true,\n \"clientStoreId\": 1193\n}\n\n ```"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"storeName\": \"Brand A\",\n \"logo\": \"https://storage.googleapis.com/download/storage/v1/b/oto-files-stage/o/files%2F24772%2Fimport%2Fb58b6d41-af83-492c-a416-d4bb0d076be1.png?generation=1721804238908930&alt=media\",\n \"defaultWarehouseID\": 16415,\n \"stores\": [\n {\n \"storeName\": \"store A\",\n \"salesChannelCredentialsID\": 4512\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/createBrand",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "createBrand"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "d5b1cacf0d118a345a53d32408e100f5"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 24 Jul 2024 07:30:38 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "37"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Access-Control-Allow-Origin",
"value": ""
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST,GET,OPTIONS,PUT,DELETE,HEAD"
},
{
"key": "Access-Control-Allow-Headers",
"value": "Accept, Origin, Content-Type, Authorization, x-forwarded-authorization, X-Requested-With"
},
{
"key": "Access-Control-Allow-Credentials",
"value": "true"
},
{
"key": "Access-Control-Expose-Headers",
"value": "x-app-version, x-fetch-date"
},
{
"key": "Access-Control-Max-Age",
"value": "728000"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"clientStoreId\": 1193\n}"
}
]
}
]
},
{
"name": "Sales Channels",
"item": [
{
"name": "Sales Channels List",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/getSalesChannelsList",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "salesChannel", "getSalesChannelsList"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides a list of all sales channels integrated with OTO. If you have a store with any of these sales channels, you can connect your store to OTO. Use the sales channel's unique code to configure settings through the **Sales Channels Config** and **Sales Channels Activation** API endpoints."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/getSalesChannelsList",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "salesChannel", "getSalesChannelsList"]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"salesChannelsList\": [\r\n {\r\n \"name\": \"Adobe Commerce\",\r\n \"code\": \"adobeEcommerce\"\r\n },\r\n {\r\n \"name\": \"WooCommerce\",\r\n \"code\": \"wooCommerce\"\r\n },\r\n {\r\n \"name\": \"Shopify\",\r\n \"code\": \"shopify\"\r\n },\r\n {\r\n \"name\": \"OpenCart\",\r\n \"code\": \"opencart\"\r\n },\r\n {\r\n \"name\": \"Store Hippo\",\r\n \"code\": \"storehippo\"\r\n },\r\n {\r\n \"name\": \"Foodics\",\r\n \"code\": \"foodics\"\r\n },\r\n {\r\n \"name\": \"Tsoft\",\r\n \"code\": \"tsoft\"\r\n },\r\n {\r\n \"name\": \"shahbandr\",\r\n \"code\": \"shahbandr\"\r\n },\r\n {\r\n \"name\": \"TrendyolInt\",\r\n \"code\": \"TrendyolInt\"\r\n }\r\n ]\r\n}"
}
]
},
{
"name": "Sales Channel Config",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": " {\r\n \"code\":\"shopify\"\r\n }",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/getSalesChannelConfig",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "salesChannel", "getSalesChannelConfig"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to view the required store credentials and the template for the sales channels specified in the request, which are needed for the next step: Sales Channel Activation. \nRetrieve the sales channel configuration template. \nUse this template to create a valid configuration object, similar to the given `exampleJson`. \nThis configuration object is then used to activate the sales channel with the Sales Channel Activation API endpoint.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| code | yes | string | The integration name obtained from the Sales Channels List. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": " {\r\n \"code\":\"shopify\"\r\n }",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/getSalesChannelConfig",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": [
"rest",
"v2",
"salesChannel",
"getSalesChannelConfig"
]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"code\": \"shopify\",\r\n \"storeURL\": \"\",\r\n \"adminApiAccessToken\": \"\",\r\n \"active\": true,\r\n \"storeName\": \"\"\r\n}"
}
]
},
{
"name": "Sales Channel Activation",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\": \"shopify\",\r\n \"storeURL\": \"https://shopifytest.myshopify.com\",\r\n \"adminApiAccessToken\": \"shopifytoken\",\r\n \"active\": true,\r\n \"storeName\": \"Shopify Store\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/salesChannelActivation",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "salesChannel", "salesChannelActivation"]
},
"description": "**Available Packages**: Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint is used to perform Sales Channels Activation. It enables you to activate a sales channel by providing the required configuration details.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| code | yes | string | The integration name obtained from the Sales Channels List |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"code\": \"shopify\",\r\n \"storeURL\": \"https://shopifytest.myshopify.com\",\r\n \"adminApiAccessToken\": \"shopifytoken\",\r\n \"active\": true,\r\n \"storeName\": \"Shopify Store\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/salesChannel/salesChannelActivation",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": [
"rest",
"v2",
"salesChannel",
"salesChannelActivation"
]
}
},
"_postman_previewlanguage": "Text",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": true\r\n}"
}
]
}
]
},
{
"name": "Products",
"item": [
{
"name": "Create Product",
"request": {
"method": "POST",
"header": [
{
"key": "Acc",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"productName\": \"Pencil\",\r\n \"sku\": \"1234AB123CDEas\",\r\n \"price\": \"23.5\",\r\n \"taxAmount\": \"11\",\r\n \"barcode\": \"1245125123421\",\r\n \"secondBarcode\": \"231412312\",\r\n \"description\": \"This is product description\",\r\n \"brandId\": 6345,\r\n \"category\" : \"Category of the product\",\r\n \"productImage\": \"\",\r\n \"customAttributes\": [\r\n {\r\n \"attributeName\": \"112\",\r\n \"attributeValue\": \"test product\"\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createProduct",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createProduct"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpointallows clients to add new products to the system by providing key product details. This endpoint is essential for catalog management, enabling businesses to define and register products for use in their operations, such as inventory management, sales, and order processing.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| sku | yes | string | SKU of the product |\n| productName | yes | string | Name of the product |\n| price | yes | string | Price of the product |\n| taxAmount | no | string | Tax Amount of the product |\n| brandId | no | string | Brand id of the product |\n| description | no | string | Description of the product |\n| barcode | no | string | Barcode of the product |\n| secondBarcode | no | string | Second Barcode of the product |\n| productImage | no | string | Image Link of the product |\n| category | no | string | Category of the product |\n| hsCode | no | string | A standardized numerical method of classifying traded products |\n| itemOrigin | no | string | Origin of the product |\n| bundleItems | no | boolean | It can be true/ false |\n| category | no | | Category of product |\n| customAttributes | no | JSONArray | Custom attributes of the product |\n\n**Request Paramaters for Custom Attributes array:**\n\n| **Name** | **Required** | **Type** | **Description** |\n| --- | --- | --- | --- |\n| attributeValue | no | string | Value of the attribute |\n| attributeName | yes | string | Name of the attribute |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"productName\": \"Pencil\",\r\n \"sku\": \"1234AB123CDE\",\r\n \"price\": \"23.5\",\r\n \"taxAmount\": \"11\",\r\n \"barcode\": \"1245125123421\",\r\n \"secondBarcode\": \"231412312\",\r\n \"description\": \"This is product description\",\r\n \"brandId\": 645,\r\n \"imageLink\": \"\",\r\n \"customAttributes\": [\r\n {\r\n \"attributeName\": \"112\",\r\n \"attributeValue\": \"test product\"\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createProduct",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createProduct"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 08 Nov 2023 08:24:46 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "36"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"productId\": 6084100,\n \"success\": true\n}"
},
{
"name": "400 wrong price value",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"productName\": \"Pencil\",\r\n \"sku\": \"1234AB123CDEas\",\r\n \"price\": \"23.5A\",\r\n \"taxAmount\": \"11\",\r\n \"barcode\": \"1245125123421\",\r\n \"secondBarcode\": \"231412312\",\r\n \"description\": \"This is product description\",\r\n \"brandId\": 645,\r\n \"imageLink\": \"\",\r\n \"customAttributes\": [\r\n {\r\n \"attributeName\": \"112\",\r\n \"attributeValue\": \"test product\"\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://api.tryoto.com/rest/v2/createProduct",
"protocol": "http",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "createProduct"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 09 Nov 2023 07:45:04 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "129"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1009\",\n \"otoErrorMessage\":\"Something went wrong\"\n}"
},
{
"name": "400 brand id does not exist",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"productName\": \"Pencil\",\r\n \"sku\": \"1234AB123CDEas\",\r\n \"price\": \"23.5\",\r\n \"taxAmount\": \"11\",\r\n \"barcode\": \"1245125123421\",\r\n \"secondBarcode\": \"231412312\",\r\n \"description\": \"This is product description\",\r\n \"brandId\": 6345,\r\n \"imageLink\": \"\",\r\n \"customAttributes\": [\r\n {\r\n \"attributeName\": \"112\",\r\n \"attributeValue\": \"test product\"\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://api.tryoto.com/rest/v2/createProduct",
"protocol": "http",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "createProduct"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 09 Nov 2023 07:45:49 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "69"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\":\"OTO1100\",\n \"otoErrorMessage\":\"Brand is missing or invalid\"\n}"
}
]
},
{
"name": "Product List",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"pageSize\":100,\r\n \"currentPage\":1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/productList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "productList"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint provides a simple and efficient way to retrieve a list of products available in your inventory. This endpoint returns essential product details such as names, images, SKUs, and barcodes, enabling applications to display and manage product information effectively. \n**Request Parameters:**\n\n| **Name** | **Required** | **Type** | **Description** |\n| --- | --- | --- | --- |\n| pageSize | no | number | items per page, default is 100 |\n| currentPage | no | number | page numbe to be called, default is 1 |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"pageSize\":100,\r\n \"currentPage\":1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/productList",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "productList"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "7d403a627766e75eae3f4cde23d62486;o=1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Tue, 21 Dec 2021 11:51:00 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "482"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"productCount\": 3,\n \"products\": [\n {\n \"name\": \"renegade\",\n \"productImage\": \"https://i.pinimg.com/564x/8b/46/bd/8b46bd024b6a53f09ad35c29f8ffb50b.jpg\",\n \"sku\": \"001\",\n \"barcode\": \"1111\"\n },\n {\n \"name\": \"football\",\n \"productImage\": \"https://i.pinimg.com/236x/e4/be/bb/e4bebbaf7a4b7efa305e198720248e9b.jpg\",\n \"sku\": \"002\",\n \"barcode\": \"6120000210\"\n },\n {\n \"name\": \"icecream\",\n \"productImage\": \"https://i.pinimg.com/236x/96/e7/ac/96e7accacdb0c1ec87c7ebfd2dc26f3b.jpg\",\n \"sku\": \"003\",\n \"barcode\": \"46666588851222000574\"\n }\n ]\n}"
}
]
},
{
"name": "Add Box",
"request": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall\",\n\"length\":25,\n\"width\":24,\n\"height\":9\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/addBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "addBox"]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint allows you to create new boxes with the dimensions you provided.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| name | yes | string | name of the box, name should be unique |\n| length | yes | double | length of the package |\n| width | yes | double | width of the package |\n| height | yes | double | height of the package |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xlarge\",\n\"length\":22,\n\"width\":24,\n\"height\":9\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/addBox",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "addBox"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "53"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:00:46 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"Box successfully created\"\n}"
},
{
"name": "409-already exists",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xlarge\",\n\"length\":22,\n\"width\":24,\n\"height\":9\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/addBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "addBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "127"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:01:04 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1147\",\n \"otoErrorMessage\": \"Box already exists\"\n}"
},
{
"name": "409-invalid json",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xlarge\",\n\"length\":22\n\"width\":24,\n\"height\":9\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/addBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "addBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:01:39 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1075\",\n \"otoErrorMessage\": \"Invalid Json format\"\n}"
},
{
"name": "409",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xlarge1\",\n\"length\":true,\n\"width\":24,\n\"height\":9\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/addBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "addBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:02:27 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1009\",\n \"otoErrorMessage\": \"Something went wrong\"\n}"
}
]
},
{
"name": "Update Box",
"request": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall\",\n\"length\":3,\n\"width\":4,\n\"height\":3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateBox"]
},
"description": "**Available Packages:** All Packages\n\nYou can change the dimension information of an existing box. Since the name is unique, you can change the information of that box by entering the name information in the request."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall\",\n\"length\":3,\n\"width\":4,\n\"height\":3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/updateBox",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "updateBox"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "53"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:09:56 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"Box successfully updated\"\n}"
},
{
"name": "409-not found",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall-1\",\n\"length\":3,\n\"width\":4,\n\"height\":3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:04:01 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1149\",\n \"otoErrorMessage\": \"Box could not be found\"\n}"
},
{
"name": "409-invalid json",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall\",\n\"length\":3\n\"width\":4,\n\"height\":3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:04:21 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1075\",\n \"otoErrorMessage\": \"Invalid Json format\"\n}"
},
{
"name": "409",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\"name\":\"xsmall\",\n\"length\":true,\n\"width\":4,\n\"height\":3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateBox"]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "135"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:04:38 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1009\",\n \"otoErrorMessage\": \"Something went wrong\"\n}"
}
]
},
{
"name": "Get Box",
"request": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "{{real-url}}/rest/v2/getBox",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getBox"],
"query": [
{
"key": "name",
"value": "medium",
"disabled": true
}
]
},
"description": "**Available Packages:** All Packages\n\nThis API endpoint you to retrieve the name, id and dimension information of all boxes currently in your account."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "https://api.tryoto.com/rest/v2/getBox?name=medium",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "getBox"],
"query": [
{
"key": "name",
"value": "medium"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "90"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:05:48 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"boxes\": [\n {\n \"length\": 10,\n \"width\": 9,\n \"boxName\": \"medium\",\n \"id\": 2642,\n \"height\": 5\n }\n ],\n \"success\": true\n}"
},
{
"name": "409-not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImJjNDAxN2U3MGE4MWM5NTMxY2YxYjY4MjY4M2Q5OThlNGY1NTg5MTkiLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI4NjQiLCJjbGllbnRUeXBlIjoicmV0YWlsIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VyTmFtZSI6IkRlbW8gTmljZW9uZSIsInVzZXJJZCI6IjI0NzYiLCJlbWFpbCI6Im5pY2VvbmVkZW1vQHRyeW90by5jb20iLCJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vb3RvLXN0YWdlLWFwaSIsImF1ZCI6Im90by1zdGFnZS1hcGkiLCJhdXRoX3RpbWUiOjE3MDE1NjI1MDYsInVzZXJfaWQiOiJTY1V5cTFsREczTmhiV3ZFMDh4WmQwc3VoYUQzIiwic3ViIjoiU2NVeXExbERHM05oYld2RTA4eFpkMHN1aGFEMyIsImlhdCI6MTc0MTUyNTIyOSwiZXhwIjoxNzQxNTI4ODI5LCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsibmljZW9uZWRlbW9AdHJ5b3RvLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6ImN1c3RvbSJ9fQ.IuVELOE63H67tMeaH1l3NH2WaXEg-tdYE0Nlnei8EimDWTFSpRsCOG0MUZUQf6QeexeW1RoV9ZoAflVKX6Dg6bQNYIEiB7sL-nLWBbbpDCOmv5mC2PcvweY8fWOvUIHLcTZZjnwGTILFfbVZFQQbhVtiIjH3lc0G7h1WKZPd8qk3kgiAd5O2_Q4cJLKVtFf1PH4jB-BMYjvS2QUquQNPPH6w1hXJQ5A9LQtdvuU_UyE5lRs25LDA38ZAGPht8Lez7Go2j9N9Q7aFcauPtbzfJgq4DWaLTQzyycScFcRPR3_su7Cx6CgCqbImqbRaFG6NmUWiYDB6ZkPoARlmjEblqA",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "{{real-url}}/rest/v2/getBox?name=2",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getBox"],
"query": [
{
"key": "name",
"value": "2"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "0"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, max-age=0, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "137"
},
{
"key": "Date",
"value": "Sun, 09 Mar 2025 13:06:04 GMT"
},
{
"key": "Keep-Alive",
"value": "timeout=60"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1149\",\n \"otoErrorMessage\": \"Box could not be found\"\n}"
}
]
}
]
},
{
"name": "Stock Management",
"item": [
{
"name": "Update Stock Quantity",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjust\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"40\"\r\n}"
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint enables efficient inventory management by allowing you to update the quantity of a SKU in two flexible ways:\n\n1. **Adjust**: Modify the existing quantity by adding or deducting a specified amount. To decrease the quantity, provide a negative value for `qty`. For example, setting `qty` to `-5` will deduct 5 units from the current stock.\n \n2. **Set**: Directly set the quantity on hand to a specific value, replacing the current stock with the provided `qty`.\n \n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| actionType | yes | enum | \"set\",\"adjust\" |\n| locationCode | yes | string | Location code of the inventory |\n| sku | yes | string | SKU of the product in the inventory |\n| qty | yes | integer | Quantity to be set or adjusted in the inventory |"
},
"response": [
{
"name": "200 actionType \"set\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"type": "text"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"set\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"1\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 10:45:14 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "123"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"Inventory quantity set to the given qty according to the action type\"\n ],\n \"transactionID\": 591611\n}"
},
{
"name": "200 actionType \"adjust\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"type": "text"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjust\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"40\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 11:08:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "100"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"warnings\": [\n \"Inventory quantity increased by the given qty\"\n ],\n \"transactionID\": 591620\n}"
},
{
"name": "400 invalid quantity",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjust\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"40.75\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 11:11:36 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "65"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1132\",\n \"otoErrorMessage\": \"Quantity is missing or invalid\"\n}"
},
{
"name": "400 invalid SKU",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjust\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561123412312\",\r\n \"qty\": \"40\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 11:11:55 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "86"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1126\",\n \"otoErrorMessage\": \"sku is missing or invalid\"\n}"
},
{
"name": "400 invalid location code",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjust\",\r\n \"locationCode\": \"ASDSA\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"40\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 11:12:10 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "107"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1133\",\n \"otoErrorMessage\": \"Location Code is missing or invalid\"\n}"
},
{
"name": "400 invalid actionTypr",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-forwarded-authorization",
"value": "Bearer {{staging-feasibility}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"actionType\": \"adjuast\",\r\n \"locationCode\": \"ASDS\",\r\n \"sku\": \"156487494561\",\r\n \"qty\": \"40\"\r\n}"
},
"url": {
"raw": "{{real-url}}/rest/v2/updateStockQuantity",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updateStockQuantity"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 16 Nov 2023 11:12:33 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "80"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1130\",\n \"otoErrorMessage\": \"actionType is required\"\n}"
}
]
},
{
"name": "Check Inventory Stock",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/checkInventoryStock?sku=SG1,SG2,SG3",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkInventoryStock"],
"query": [
{
"key": "sku",
"value": "SG1,SG2,SG3"
}
]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to retrieve real-time stock availability for products at specific locations.\n\nIt provides detailed information on the quantity of items on hand and forecasted stock for each product at various pickup locations, offering a location-based view of inventory distribution.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| sku | yes | string | The product's SKU identifier |\n\n**Response:**\n\n- **success**: Indicates whether the request was successful (`true` or `false`).\n \n- **stock**: A dictionary with SKUs as keys, containing a list of stock details for each location:\n \n - **pickupLocationCode**: The code representing the specific location.\n \n - **sku**: The product's SKU identifier.\n \n - **quantityForecasted**: The forecasted stock level at the location.\n \n - **quantityOnHand**: The actual available stock at the location."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/checkInventoryStock?sku=SG1,SG2,SG3",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "checkInventoryStock"],
"query": [
{
"key": "sku",
"value": "SG1,SG2,SG3"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "c4fe578fca49fa3b709de526ac5ecfc1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 13 Dec 2021 20:37:51 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "569"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"stock\": {\n \"SG1\": [\n {\n \"pickupLocationCode\": \"DMW\",\n \"sku\": \"SG1\",\n \"quantityForecasted\": 261,\n \"quantityOnHand\": 277\n },\n {\n \"sku\": \"SG1\",\n \"quantityForecasted\": -16,\n \"quantityOnHand\": -7\n }\n ],\n \"SG3\": [\n {\n \"pickupLocationCode\": \"DMW\",\n \"sku\": \"SG3\",\n \"quantityForecasted\": 55,\n \"quantityOnHand\": 67\n },\n {\n \"sku\": \"SG3\",\n \"quantityForecasted\": -7,\n \"quantityOnHand\": -6\n }\n ],\n \"SG2\": [\n {\n \"pickupLocationCode\": \"DMW\",\n \"sku\": \"SG2\",\n \"quantityForecasted\": 185,\n \"quantityOnHand\": 198\n },\n {\n \"sku\": \"SG2\",\n \"quantityForecasted\": -20,\n \"quantityOnHand\": -12\n }\n ]\n }\n}"
}
]
},
{
"name": "Check Global Stock",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/checkGlobalStock?sku=12,123123",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "checkGlobalStock"],
"query": [
{
"key": "sku",
"value": "12,123123"
}
]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint provides an overview of total stock availability for SKUs across all locations. This endpoint aggregates stock levels to display a global view, helping businesses understand their overall inventory status.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| sku | yes | string | The product's SKU identifier |\n\n**Response:**\n\n- **success**: Indicates whether the request was successful (`true` or `false`).\n \n- **stock**: A dictionary with SKUs as keys, containing global stock details for each product:\n \n - **sku**: The product's unique SKU identifier.\n \n - **quantityOnHand**: The total quantity of the product available across all locations.\n \n - **quantityForecasted**: The total forecasted stock quantity, if applicable.\n \n - **minInventory**: The minimum inventory threshold for the product, if defined."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/checkGlobalStock?sku=12,123123",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "checkGlobalStock"],
"query": [
{
"key": "sku",
"value": "12,123123"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "c4fe578fca49fa3b709de526ac5ecfc1"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "clear"
},
{
"key": "Date",
"value": "Mon, 13 Dec 2021 20:37:51 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "569"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"stock\": {\n \"12\": [\n {\n \"minInventory\": 50,\n \"sku\": \"12\",\n \"quantityForecasted\": 122,\n \"quantityOnHand\": 39\n }\n ],\n \"123123\": [\n {\n \"sku\": \"123123\",\n \"quantityOnHand\": 14\n }\n ]\n }\n}"
}
]
},
{
"name": "Create Inventory Order",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"action\":\"inbound\",\r\n \"locationCode\": \"WHA\",\r\n \"binLocationName\": \"test\",\r\n \"orderDate\": \"31/03/2022\",\r\n \"deliveryDate\": \"31/03/2023\",\r\n \"waybillNumber\": \"12345\",\r\n \"description\": \"loc1\",\r\n \"items\": [\r\n {\r\n \"sku\": \"123123\",\r\n \"qty\": \"1\"\r\n }\r\n ]\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createInventoryOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createInventoryOrder"]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint creates inventory order as inbound or outbound for a warehouse or branch location. This API is used mostly to provide the incoming or outgoing bulk items from ERP systems to OTO. Once the order is created the status will be new for the warehouse or branch to accept and process the order.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| action | yes | enum | \"inbound\": Creates the order as purchase type and sets the ingoing location field <br>\"outbound\": Creates the order as disposal and sets the outgoing location field |\n| locationCode | yes | string | Code of the warehouse or the branch of the inventory |\n| binLocationName | no | string | Name of the desired Bin |\n| orderDate | no | date | Date of the order, must be a valid date value |\n| deliveryDate | no | date | Date of the delivery, must be a valid date value |\n| waybillNumber | no | string | WayBillNumber of the order |\n| description | no | string | Arbitrary description of the order |\n| items | no | JSONArray | An array of the items of the order |\n\n**Request paramaters for Items array:**\n\n| **Name** | **Required** | **Type** | **Description** |\n| --- | --- | --- | --- |\n| sku | yes | string | SKU of the item of the customer that exists on database |\n| qty | yes | integer | Quantity of the item, must be a positive number |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"action\":\"inbound\",\r\n \"locationCode\": \"WHA\",\r\n \"binLocationName\": \"test\",\r\n \"orderDate\": \"31/03/2022\",\r\n \"deliveryDate\": \"31/03/2023\",\r\n \"waybillNumber\": \"12345\",\r\n \"description\": \"loc1\",\r\n \"items\": [\r\n {\r\n \"sku\": \"123123\",\r\n \"qty\": \"1\"\r\n }\r\n ]\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createInventoryOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createInventoryOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 08 Nov 2023 08:23:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "29"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 4026\n}"
},
{
"name": "400 wrong location code",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"action\":\"inbound\",\r\n \"locationCode\": \"WHASA\",\r\n \"binLocationName\": \"test\",\r\n \"orderDate\": \"31/03/2022\",\r\n \"deliveryDate\": \"31/03/2023\",\r\n \"waybillNumber\": \"12345\",\r\n \"description\": \"loc1\",\r\n \"items\": [\r\n {\r\n \"sku\": \"123123\",\r\n \"qty\": \"1\"\r\n }\r\n ]\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createInventoryOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createInventoryOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 09 Nov 2023 07:41:55 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "107"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1133\",\n \"otoErrorMessage\": \"Location Code is missing or invalid\"\n}"
},
{
"name": "400 wrong action value",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"action\":\"inbouand\",\r\n \"locationCode\": \"WHA\",\r\n \"binLocationName\": \"test\",\r\n \"orderDate\": \"31/03/2022\",\r\n \"deliveryDate\": \"31/03/2023\",\r\n \"waybillNumber\": \"12345\",\r\n \"description\": \"loc1\",\r\n \"items\": [\r\n {\r\n \"sku\": \"123123\",\r\n \"qty\": \"1\"\r\n }\r\n ]\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createInventoryOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createInventoryOrder"]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 09 Nov 2023 07:42:13 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "82"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": false,\n \"otoErrorCode\": \"OTO1136\",\n \"otoErrorMessage\": \"Action is missing or invalid\"\n}"
},
{
"name": "200 wrong date format ignored",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "x-forwarded-authorization",
"value": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImYyZTgyNzMyYjk3MWExMzVjZjE0MTZlOGI0NmRhZTA0ZDgwODk0ZTciLCJ0eXAiOiJKV1QifQ.eyJjb21wYW55SWQiOiI1ODAzIiwiY2xpZW50VHlwZSI6IkZyZWVQYWNrYWdlIiwidXNlclR5cGUiOiJjb21wYW55QWRtaW4iLCJ1c2VySWQiOiI5NjE2IiwiZW1haWwiOiJmZWFzaWJpbHR5QGNoZWNrLmNvbSIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9vdG8tc3RhZ2UtYXBpIiwiYXVkIjoib3RvLXN0YWdlLWFwaSIsImF1dGhfdGltZSI6MTY3OTM4Nzc2NywidXNlcl9pZCI6IjJqYXhpTnd4UGhjZkZ4cjFvNzFTeGlpaUZ5QzIiLCJzdWIiOiIyamF4aU53eFBoY2ZGeHIxbzcxU3hpaWlGeUMyIiwiaWF0IjoxNjk3MDMyODMxLCJleHAiOjE2OTcwMzY0MzEsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJmZWFzaWJpbHR5QGNoZWNrLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.TEeK7xUuFR0QlNneXE0xtvyf12tJM0zSoLum_pH-NJwqPMC2S9d8Akn99YQtoGuNTLSkwDUCuQ09CUducVTo2ZSh6GihPVC6e1iTs3s63QApyj9veWzRxvr8F5vq3acxsRm_9iLchK-l8T8LFHKimvw9NYZaojLaDYdErRhaGMxHDqML6IiAJLPAuePFlrGHRTp4LOTpOYmn6DOZF8nXgFbD90ciFWzeXWucb6bBNZgSDnC3ibNL8KA42GHJhnuVahdEFtkzUs4TqbyH3yp90wTzXpG8OeYs5qYElhYiqVnwzuhrot7a4gOo02JIeBAcRyQM0mKqtzjZwwvENEogzQ",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"action\":\"inbound\",\r\n \"locationCode\": \"WHA\",\r\n \"binLocationName\": \"test\",\r\n \"orderDate\": \"31/03/2022\",\r\n \"deliveryDate\": \"3103/2023\",\r\n \"waybillNumber\": \"12345\",\r\n \"description\": \"loc1\",\r\n \"items\": [\r\n {\r\n \"sku\": \"123123\",\r\n \"qty\": \"1\"\r\n }\r\n ]\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/createInventoryOrder",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "createInventoryOrder"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 09 Nov 2023 07:42:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "152"
},
{
"key": "Server",
"value": "Jetty(9.4.3.v20170317)"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"otoId\": 4038,\n \"warnings\": [\n \"deliveryDate is in an invalid format, order inserted without order date. Please provide dates as DD/MM/YYYY\"\n ]\n}"
}
]
},
{
"name": "Update Packing Status",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"123\",\r\n \"packingStatus\":\"packed\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePackingStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePackingStatus"]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows you to update the packing status of an order during the fulfillment process. This endpoint is used to record and track the progress of orders as they move through the packing stage, ensuring accurate status updates for operational visibility.\n\n**Request Parameters:**\n\n| Name | Required | Type | **Description** |\n| --- | --- | --- | --- |\n| orderId | yes | string | Id of the order that you wanna update packing status |\n| packingStatus | yes | string | Packing status value can be `packed` or `picked` |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"orderId\":\"123\",\r\n \"packingStatus\":\"packed\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/updatePackingStatus",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "updatePackingStatus"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"Successfully updated\"\n}"
}
]
},
{
"name": "Get Orders Ready For Packing",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"warehouseCode\": \"WH123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getPackingOrders",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getPackingOrders"]
},
"description": "**Available Packages:** Scale Package, Enterprise Package, MarketplacesEndFragment\n\nThis API endpoint retrieves a list of orders that are ready for pick and pack operations. This endpoint is designed to streamline warehouse workflows by providing access to orders that have completed prior processes and are prepared for fulfillment.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| warehouseCode | yes | String | `pickupLocationCode` of the warehouse. |"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"warehouseCode\": \"WH123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getPackingOrders",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getPackingOrders"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"success\":true,\n \"count\": 2,\n \"orders\": [\n {\n \"orderId\": \"11022\",\n \"items\": [\n {\n \"productId\": 112,\n \"name\": \"test product\",\n \"quantity\": 1,\n \"sku\": \"test-product\"\n },\n {\n \"name\": \"test product 2\",\n \"quantity\": 1,\n \"sku\": \"test-product-2\"\n }\n ]\n },\n {\n \"orderId\": \"11051222\",\n \"items\": [\n {\n \"productId\": 12312,\n \"name\": \"test2 product\",\n \"quantity\": 1,\n \"sku\": \"test-product\"\n },\n {\n \"name\": \"test3 product 3\",\n \"quantity\": 2,\n \"sku\": \"test3-product-3\"\n }\n ]\n }\n ]\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"warehouseCode\": \"WH123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/getPackingOrders",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "getPackingOrders"]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\n \"message\": \"Jwt is expired\",\n \"code\": 401\n}"
}
]
}
]
},
{
"name": "Webhook",
"item": [
{
"name": "webhook",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"method\":\"post\",\r\n \"url\":\"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\r\n \"orderPrefix\":\"fulfillment\",\r\n \"timestampFormat\":\"2025-01-01 13:14:34\",\r\n \"secretKey\":\"key1234\",\r\n \"authorizationKey\":\"authorizationkey123\",\r\n \"webhookType\":\"shipmentError\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/webhook",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis endpoint enables OTO to send update payloads to the specified URL using the defined method. Optional security measures, such as token authentication and payload validation, can be configured for enhanced security.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| method | yes | string | `POST` or `PUT` |\n| url | yes | string | Your endpoint listens to get OTO webhook payload, when order status changes. exp.`https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b` |\n| secretKey | no | string | With this key message is signed and receiver validate. |\n| authorizationKey | no | string | Secure token used to authenticate and validate incoming webhook requests. |\n| timestampFormat | no | string | Exp \"yyyy-MM-dd HH:mm:ss\" format receiver want to get. |\n| orderPrefix | no | string | If orders has prefix in OTO, then put prefix string to be removed before webhook body prepared. |\n| webhookType | no | string | `shipmentError`, sends create shipment error messages; `orderStatus` sends order status changes. default is `orderStatus and newOrders` webhook is used to create orders in a different WMS. |"
},
"response": [
{
"name": "200 webhook-order status",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"method\":\"post\",\r\n \"url\":\"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\r\n \"orderPrefix\":\"fulfillment\",\r\n \"timestampFormat\":\"2025-01-01 13:14:34\",\r\n \"secretKey\":\"key1234\",\r\n \"authorizationKey\":\"authorizationkey123\",\r\n \"webhookType\":\"orderStatus\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/webhook",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "webhook"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "4341c271e3b9c749f0555d1add18f113"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 02 Feb 2022 14:11:07 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "63"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"id\": \"59\",\n \"message\": \"webhook has been created\"\n}"
},
{
"name": "200 webhook- shipment error",
"originalRequest": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"method\":\"post\",\r\n \"url\":\"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\r\n \"orderPrefix\":\"fulfillment\",\r\n \"timestampFormat\":\"2025-01-01 13:14:34\",\r\n \"secretKey\":\"key1234\",\r\n \"authorizationKey\":\"authorizationkey123\",\r\n \"webhookType\":\"shipmentError\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/webhook",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "4341c271e3b9c749f0555d1add18f113"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 02 Feb 2022 14:11:07 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "63"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"id\": \"59\",\n \"message\": \"webhook has been created\"\n}"
}
]
},
{
"name": "webhook",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/webhook",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis endpoint allows you to retrieve a list of all registered webhook definitions. It provides detailed information about each webhook, including its configuration and associated event triggers, enabling you to manage and review your webhook integrations effectively.\n\n**Note:** You can filter by id if you know the id of the webhook.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | no | string | id of the webhook |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.tryoto.com/rest/v2/webhook",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "webhook"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "5ae767cdbb3cacc38c0de4dee7bc72b6"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 02 Feb 2022 14:11:12 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "238"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"webhooks\": [\n {\n \"method\": \"post\",\n \"secretKey\": \"secret123\",\n \"authorizationKey\": \"authorization123\",\n \"timestampFormat\": \"2025-01-01 10:10:10\",\n \"id\": 59,\n \"url\": \"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\n \"orderPrefix\": \"fulfillment\"\n }\n ],\n \"success\": true\n}"
},
{
"name": "200-filterById",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/webhook?id=59",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"],
"query": [
{
"key": "id",
"value": "59"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "040b4492b339fb264261c8fcfe739c97"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 02 Feb 2022 14:12:39 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "238"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"webhooks\": [\n {\n \"method\": \"post\",\n \"secretKey\": \"secret123\",\n \"authorizationKey\": \"authorization123\",\n \"timestampFormat\": \"2025-01-01 10:10:10\",\n \"id\": 59,\n \"url\": \"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\n \"orderPrefix\": \"fulfillment\"\n }\n ],\n \"success\": true\n}"
}
]
},
{
"name": "webhook",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"id\":59,\r\n \"method\":\"post\",\r\n \"url\":\"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\r\n \"orderPrefix\":\"test-2\",\r\n \"timestampFormat\":\"2025-01-01 10:10:10\",\r\n \"secretKey\":\"secret123\",\r\n \"authorizationKey\":\"authorizationkey123\",\r\n \"webhookType\":\"orderStatus\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{real-url}}/rest/v2/webhook",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint allows updating an already registered webhook by providing its unique ID. This ensures you can modify existing webhook configurations, such as URL, secretKey, or other parameters, without needing to delete and recreate it.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | yes | string | Id of the webhook record. |\n| method | yes | string | `POST` or `PUT` |\n| url | yes | string | Your endpoint listens to get OTO webhook payload, when order status changes. exp.`https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b` |\n| secretKey | no | string | With this key message is signed and receiver validate. |\n| authorizationKey | no | string | Authorization key. |\n| timestampFormat | no | string | Exp \"yyyy-MM-dd HH:mm:ss\" format receiver want to get. |\n| orderPrefix | no | string | If orders has prefix in OTO, then put prefix string to be removed before webhook body prepared. |\n| webhookType | no | string | `shipmentError`, sends create shipment error messages; `orderStatus` sends order status changes. default is `orderStatus and newOrders` webhook is used to create orders in a different WMS. |"
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"id\":59,\r\n \"method\":\"POST\",\r\n \"url\":\"https://webhook.site/3e53c98a-a089-4ca4-9bc4-df10e5a71e4b\",\r\n \"orderPrefix\":\"test-2\",\r\n \"timestampFormat\":\"2025-01-01 10:10:10\",\r\n \"secretKey\":\"secret123\",\r\n \"authorizationKey\":\"authorization123\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/webhook",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "webhook"]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "X-Cloud-Trace-Context",
"value": "f80e87e442367c64b2e0d7deab70bb50"
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000,h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Alt-Svc",
"value": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
},
{
"key": "Date",
"value": "Wed, 02 Feb 2022 14:12:05 GMT"
},
{
"key": "Server",
"value": "Google Frontend"
},
{
"key": "Content-Length",
"value": "53"
},
{
"key": "Via",
"value": "1.1 google"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"message\": \"webhook has been updated\"\n}"
}
]
},
{
"name": "webhook",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/webhook",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces \n\nThis API endpoint enables the removal of a registered webhook from the system using its unique ID. This ensures you can effectively manage and clean up webhook configurations that are no longer needed.\n\n**Request Parameters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| id | yes | string | Id of the webhook record. |"
},
"response": [
{
"name": "webhook",
"originalRequest": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{real-url}}/rest/v2/webhook?id=3",
"host": ["{{real-url}}"],
"path": ["rest", "v2", "webhook"],
"query": [
{
"key": "id",
"value": "3"
}
]
}
},
"_postman_previewlanguage": "json",
"header": null,
"cookie": [],
"body": "{\r\n \"success\": true,\r\n \"message\": \"webhook has been deleted\"\r\n}"
}
]
}
],
"description": "# WEBHOOK for ORDER\n\nThere are 3 types of webhook for now, `newOrders,` `orderStatus` and `shipmentError`.\n\nOTO will push updates to the registered webhook endpoint for the `orderStatus` type whenever an order status changes. This includes statuses such as Processing, Delivered, Returned, and more. \nOTO will push an update via the `shipmentError` webhook type, providing details about the error, if an error occurs while an order shipment. \nOTO will push the order details to you through the `newOrders` webhook type, If you need to create an existing order in a different WMS system.\n\ntimestamp value belongs to UTC time zone.\n\n``` json\n{\n \"orderId\": \"1234\",\n \"status\": \"shipmentProcessing|delivered|returned|...\",\n \"dcStatus\": \"status coming from the delivery company\",\n \"note\": \"optional note to show in order history\",\n \"pickupLocationCode\":\"code-101\",\n \"driverName\": \"FirstName LastName\",\n \"driverPhone\": \"966555444333\",\n \"driverEmail\": \"[email protected]\",\n \"driverId\":\"123124\", \n \"printAWBURL\": \"https://app.tryoto.com/OTOAWB?enc=eyJpZHMiOlsxMjU1MDkzOF0sImNvbXBhbnlJZCI6MTQ5MjF9\",\n \"trackingNumber\": \"ASD00123\",\n \"dcTrackingNumber\":\"983643812\",\n \"trackingUrl\": \"www.example…...\",\n \"deliveryCompany\": \"fastExpress\",\n \"timestamp\": \"1595941360328\",\n \"signature\": \"S7aLSdZjfZAIf9IOArNgTLI5PXhKDkTeYmrhIfhpE79REU2NLg6Kbeb9KavwRfhV3UhAoFNefnezBEbnn5VO7GlTN4FSESUjf1wKctrfO5gJLFuK2JhIG/p32HSj7A4XvvVYg1xWNOmuM9Ua61zyR7TG5gC0fDipDYcxYAd4vP/RvqWm056IwIRAuevlxLr/EL6JuS9gmNGrAXz733rkjt6RV+ZmFS4VAtSK/WDQOQU3o2CyJipCA6cCo9DRwvHrzUYZNWMakpi70wjhajZRZ5L/4Z7u3D21FsB/LUeRQ9D5niVCaNjDU3e9PQe9ig1frR3LsYOiz5Y0UAyq9izfKg==\"\n}\n\n ```\n\nSigned “orderId:status:timestamp” with “HmacSHA256” method and Base64 Encoded string. \nPublic key for the signature will be shared on private.\n\nif registered to `shipmentError`, endpoint will get a payload:\n\n``` json\n{\n \"orderId\": \"7523\",\n \"signature\": \"bQnNzL2VVwu0joYPfx6Qs3lsoEdVCMR+5xSPdMbABFE=\",\n \"errorMessage\": \"delivery company not allow to create shipment\",\n \"deliveryCompanyResponse\": \"error: Shipper.PartyAddress - City/Zipcode is empty\",\n \"errorCode\": \"deliveryCompanyError\",\n \"deliveryCompany\": \"aramex\",\n \"timestamp\": \"1653642441399\"\n}\n\n ```\n\nSigned “orderId:errorCode:timestamp” with “HmacSHA256” method and Base64 Encoded string. \nPublic key for the signature will be shared on private.\n\nif registered to `newOrders`, endpoint will get a payload:\n\n``` json\n{\n \"order\": {\n \"address\": {\n \"country\": \"AE\",\n \"address\": \"46C3+Q7 Dubai - United Arab Emirates\",\n \"city\": \"Dubai\",\n \"name\": \"fatmanur\",\n \"mobile\": \"966513321131\",\n \"state\": \"Dubai\"\n },\n \"warehouseId\": 11083,\n \"grandTotal\": 1,\n \"otoId\": 14796940,\n \"paymentMethod\": \"paid\",\n \"weight\": 1,\n \"currency\": \"SAR\",\n \"incrementId\": \"OID-23331-1035\",\n \"salesChannel\": \"manual\",\n \"brand\": \"Example Brand\",\n \"codFee\": 0.0,\n \"items\": [\n {\n \"itemId\": 12402868,\n \"qtyOrdered\": 1,\n \"sku\": \"10143\",\n \"qtyReturned\": null,\n \"productId\": \"string\",\n \"productName\": \"string\"\n \"itemType\": \"string\",\n }\n ],\n \"status\": \"assignedToWarehouse\"\n },\n \"timestamp\": 1742822768001\n}\n\n ```",
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [""]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [""]
}
}
]
},
{
"name": "OTO FLEX",
"item": [
{
"name": "assignDriver",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"orderIDs\": [3079460],\n \"driverID\": 8702\n}\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.tryoto.com/rest/v2/assignDriver",
"protocol": "https",
"host": ["api", "tryoto", "com"],
"path": ["rest", "v2", "assignDriver"]
},
"description": "**Available Packages:** Starter Package, Scale Package, Enterprise Package, Marketplaces\n\nThis API endpoint enables clients to assign a specific driver to their shipments for the OTO Flex app. This endpoint streamlines the allocation process, allowing businesses to efficiently manage driver assignments and ensure smooth delivery operations.\n\n \n**Request Paramaters:**\n\n| Name | Required | Type | Description |\n| --- | --- | --- | --- |\n| orderIDs | yes | array | An array of orderIDs objects containing the order ids |\n| driverID | yes | long | ID of the driver |"
},
"response": []
}
]
},
{
"name": "List Of Statuses",
"item": [],
"description": "| | **Stage** | Description |\n| --- | --- | --- |\n| new | Order Management | New order |\n| paymentConfirmed | Order Management | Payment is confirmed for the order |\n| waitingAddressConfirmation | Order Management | Order waits address confirmation by customer |\n| addressConfirmed | Order Management | Customer confirmed the order address |\n| needConfirmation | Order Management | Order waits for confirmation |\n| paymentTypeConfirmed | Order Management | The payment type and amounts are confirmed |\n| codOrderConfirmed | Order Management | COD order is confirmed by end customer |\n| orderConfirmed | Order Management | Order is confirmed |\n| pickupFromStore | Order Management | Order will be collected by end customer |\n| interDepotTransfer | Order Management | Order is shipping to another warehouse before shipping to the end customer |\n| canceled | Order Management | Order is canceled |\n| deleted | Order Management | Order is deleted |\n| readyForCollection | Warehouse Management | Order is ready to be collected by end customer |\n| branchAssigned | Warehouse Management | Order is assigned to branch |\n| assignedToWarehouse | Warehouse Management | Order is assigned to warehouse |\n| shipmentOnHoldWarehouse | Warehouse Management | Shipment is on hold by warehouse |\n| shipmentOnHoldToCancel | Warehouse Management | Shipment is on hold by warehouse |\n| notAvailableBR | Warehouse Management | Order is not available in the assigned branch |\n| notAvailableWH | Warehouse Management | Order is not available in the assigned warehouse |\n| picked | Warehouse Management | Order items picked by picker |\n| packed | Warehouse Management | Order items packed by packer |\n| searchingDriver | Creation | Shipment created and waiting for delivery company to assign driver |\n| shipmentCreated | Creation | Shipment accepted by the delivery company and driver is assigned |\n| goingToPickup | Creation | Driver is going to pickup location |\n| arrivedPickup | Creation | Driver arrived to pickup location and receiving the package |\n| pickedUp | Pickup | Shipment is picked up by |\n| arrivedDestinationTerminal | Transit | Shipment arrived to final destination hub of delivery company |\n| arrivedTerminal | Transit | Shipment arrived to delivery company's facility |\n| departedTerminal | Transit | Shipment left the delivery company's facility |\n| inTransit | Transit | Shipment is on the way through to destination |\n| arrivedOriginTerminal | Transit | Shipment arrived to origin hub of delivery company |\n| outForDelivery | Transit | Driver is on the way to end customer to deliver the package |\n| arrivedDestination | Transit | Shipment arrived to destination |\n| shipmentInProgress | Transit | Shipment is under process |\n| undeliveredAttempt | Transit | Shipment attempted for delivery but not successful |\n| shipmentOnHold | Transit | Shipment on hold by delivery company |\n| delivered | Delivery | Order is delivered to end customer successfully |\n| returned | Returned | Order is returned back to origin |\n| returnProcessing | Failed | Shipment is under return process |\n| returnShipmentProcessing | Failed | Shipment is under return process |\n| reverseShipmentProcessing | Reverse Creation | Reverse shipment created and waiting for delivery company to assign driver |\n| reverseShipmentCreated | Reverse Creation | Reverse Shipment is created for the order |\n| reverseShipmentCanceled | Tracking and Return Management | Reverse Shipment is canceled for the order |\n| reverseGoingToPickup | Reverse Creation | Driver is going to pickup location for reverse shipment |\n| reversePickedUp | Reverse Pickup | Reverse Shipment is picked up by delivery company |\n| reverseOutForDelivery | Reverse Transit | Reverse Shipment is on the way to |\n| reverseArrivedTerminal | Reverse Transit | Reverse shipment arrived to delivery company's facility |\n| reverseDepartedTerminal | Reverse Transit | Reverse shipment left the delivery company's facility |\n| reverseArrivedDestinationTerminal | Reverse Transit | Reverse shipment arrived final destination delivery company facility before the delivery |\n| reverseUndeliveredAttempt | Reverse Transit | Reverse Shipment attempted for delivery but not successful |\n| reverseShipmentOnHold | Reverse Transit | Reverse shipment on hold by delivery company |\n| reverseReturned | Reverse Delivery | Reverse Shipment returned to destination location |\n| reverseConfirmReturn | Tracking and Return Management | Returned order items are confirmed by warehouse/branch |\n| shipmentCanceled | Tracking and Return Management | Shipment is canceled |\n| lostOrDamaged | Tracking and Return Management | Shipment is lost or damaged |\n| confirmedReturn | Tracking and Return Management | Returned order items are confirmed by warehouse/branch |\n| approved | Tracking and Return Management | Return request approved |\n| rejected | Tracking and Return Management | Return request rejected |\n| reverseShipmentCanceled | Tracking and Return Management | Reverse shipment is canceled |\n| reverseConfirmReturn | Tracking and Return Management | Reverse returned order items are confirmed by warehouse/branch |\n| returnReverseComment | Tracking and Return Management | Comment of returned reverse order |"
},
{
"name": "Error Codes",
"item": [],
"description": "**HTTP Status Codes**\n\n| Error Code | Error Description |\n| --- | --- |\n| 200 | SUCCESS |\n| 400 | BAD REQUEST |\n| 403 | FORBIDDEN |\n| 404 | NOT FOUND |\n| 409 | CONFLICT |\n| 500 | INTERNAL_SERVER_ERROR |\n\n**OTO Error Codes**\n\nError codes and messages are returned as otoErrorCode and otoErrorMessage responses.\n\n| **OTO Error Code** | **OTO Error Description** |\n| --- | --- |\n| OTO1001 | Invalid or missing order Id |\n| OTO1002 | Order is not exist |\n| OTO1004 | There is no available delivery company setting |\n| OTO1006 | Credit is not enough |\n| OTO1009 | Something went wrong |\n| OTO1010 | Check the missing details |\n| OTO1011 | Shipment is already exist |\n| OTO1015 | Database Error |\n| OTO1016 | Sender details are missing or invalid |\n| OTO1021 | Recipient address is missing or invalid |\n| OTO1022 | Recipient city is missing or invalid |\n| OTO1029 | Recipient name is missing or invalid |\n| OTO1030 | Recipient phone is missing or invalid |\n| OTO1049 | Weight is missing or invalid |\n| OTO1063 | Order Id is already exist |\n| OTO1067 | Order Status is not allowed for update |\n| OTO1070 | Pickup location code is missing or invalid |\n| OTO1071 | Item has pickupLocation array for split order process but the input is invalid in the array. |\n| OTO1072 | This orderId is used on another split item before. |\n| OTO1073 | Box name is missing or invalid |\n| OTO1074 | Invalid items |\n| OTO1075 | Invalid Json format |\n| OTO1077 | Error occurred while generating zpl data |\n| OTO1079 | Shipment id is required |\n| OTO1080 | This account is not authorized for the use this service |\n| OTO1082 | Order Status is not allowed for cancel shipment |\n| OTO1083 | Refresh Token is required |\n| OTO1084 | Login is required |\n| OTO1085 | Email is missing or invalid |\n| OTO1086 | User does not exist |\n| OTO1087 | Country is missing or invalid |\n| OTO1088 | This action is not allowed for this token |\n| OTO1089 | Company already exists |\n| OTO1090 | Unknown integration |\n| OTO1091 | Sales channel registration error |\n| OTO1092 | Company registration error |\n| OTO1093 | Amount is required |\n| OTO1094 | Store name is missing or invalid |\n| OTO1095 | Brand name already exists |\n| OTO1096 | Invalid or missing delivery company information |\n| OTO1097 | City information is missing or invalid |\n| OTO1098 | Lat and Lon is missing or invalid |\n| OTO1099 | Integration code is required |\n| OTO1100 | Brand is missing or invalid |\n| OTO1101 | Settings is required |\n| OTO1102 | Volumetric weight rate is missing or invalid |\n| OTO1103 | Status of the order is not suitable for the action |\n| OTO1104 | Customer is missing or invalid |\n| OTO1105 | Wait for 1 minute before request again! |\n| OTO1106 | whoPays parameter is missing or invalid |\n| OTO1107 | minDate or maxDate is missing or invalid |\n| OTO1108 | Status is required |\n| OTO1109 | SMS is missing or invalid |\n| OTO1110 | On Hold reason is missing or invalid |\n| OTO1111 | Reason config is missing or invalid |\n| OTO1112 | Maximum order id number exceeded! |\n| OTO1113 | Shipment is not exist |\n| OTO1114 | SMS service error occurred |\n| OTO1116 | Delivery company couldn't respond properly. |\n| OTO1117 | Branch has already exist. |\n| OTO1118 | Serving radius is not a number! |\n| OTO1119 | Type should be branch or warehouse! |\n| OTO1120 | You cannot register more than 10 webhooks |\n| OTO1121 | url, method must be provided. |\n| OTO1122 | Url already registered for this company |\n| OTO1123 | authorizationKey size is longer than 255 |\n| OTO1124 | secretKey size is longer than 255 |\n| OTO1125 | webhook id is required |\n| OTO1126 | sku is missing or invalid |\n| OTO1127 | productName required |\n| OTO1128 | price required |\n| OTO1129 | taxAmount required |\n| OTO1130 | actionType is required |\n| OTO1131 | packingStatus is required |\n| OTO1132 | Quantity is missing or invalid |\n| OTO1133 | Location Code is missing or invalid |\n| OTO1134 | Inventory could not be found with given SKU and locationCode |\n| OTO1135 | Stock is missing or invalid |\n| OTO1136 | Action is missing or invalid |\n| OTO1137 | Given binLocationName does not exist on database |\n| OTO1138 | Driver id is missing or invalid |\n| OTO1139 | Driver not found! |\n| OTO1140 | Driver capacity is exceeded! |\n| OTO1141 | PDF Not found |\n| OTO1142 | perPage and page are required. |\n| OTO1143 | Too many request! |\n| OTO1144 | attributeValue or attributeName fields are missing or invalid. |\n| OTO1145 | Order array is required! |\n| OTO1146 | Integration name missing |\n| OTO1147 | Box already exists |\n| OTO1148 | Dimension unit is missing or invalid |\n| OTO1149 | Box could not be found |\n| OTO1150 | You do not have access to this resource. Please upgrade your plan. |\n| OTO1151 | Invalid URL format for store ur |\n| OTO1152 | Sales channels code is missing or wrong |\n| OTO1153 | Sales channels information is missing or wrong |\n| OTO1154 | Store name already exists |\n| OTO1155 | Requested amount is less than the minimum charge amount |\n| OTO1156 | PaymentURL could not be generated |\n| OTO1157 | productId and locationId must be unique |\n| OTO1158 | Integrator request is not open for import |\n| OTO1159 | Reverse request is not open for import |\n| OTO1160 | Aggregator request is not open for update |\n| OTO1161 | otoDriverApp request is not open for update |\n| OTO1162 | Update failed |\n| OTO1163 | Order Status is not suitable for shipment update |\n| OTO1164 | Upload of file failed |\n| OTO1165 | Free Package users can only have one delivery company added |\n| OTO1166 | Invalid Add Missing Shipment Request, please check the input |"
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [""]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [""]
}
}
],
"variable": [
{
"key": "real-url",
"value": "https://api.tryoto.com"
},
{
"key": "test-url",
"value": "https://staging-api.tryoto.com"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment