{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"622d73de-d94c-464f-9af3-a75539fc0b80","name":"One-touch solution for ecommerce logistics – specifications","description":"Welcome to the API documentation about the Agility Shipa Ecommerce one-touch solution for ecommerce logistics!\n\nThe solution is a one-stop platform for merchants (online stores) and supply chain partners: instead of integrating separately with each supply chain touchpoint—shipping, customs clearance, last mile delivery provider, or other—integrate with us once and get instant visibility across all the delivery touchpoints.\n\n### Learn how our API supports ecommerce logistics\n\n\n\nExpand the \"Details\" below to view the API methods related to each step in the shipping process.\n\n| Event | Related API methods |\n| --- | --- |\n| _Step 1_. When a consumer places an order for a merchant (for example, at an online store), a package (also called \"parcel\") is created in the Shipa Ecommerce platform.
A package label is generated and a commercial invoice is attached to the package in the platform by the merchant’s team. | Create a parcel,
Generate a parcel label,
Add attachment to parcel |\n| _Step 2_. Based on their destination and high/low value, packages are sorted into containers (bags) by the merchant's team or at the fulfillment hub.
At this point, container labels may be generated and manifests may be attached to containers in the platform. | Create a container,
Add parcel(s) to a container,
Generate a container label,
Add attachment to container |\n| _Step 3_. When a bag is filled and ready to be shipped, it gets loaded onto an aircraft at the origin hub. | Close a container |\n| _Step 4_. A trace with the location, timestamp, and status update is added to the container and by association, to the packages within that container.
Starting from this moment, the consumer and the store admin, as well as the supply chain partners can start tracking the package. | Add trace to a parcel/container,
Track a parcel |\n| _Step 5_. The packages begin their journey to the destination.
When packages pass the customs clearance and arrive at the transit hub, more traces are added.
As a result, the consumer and the store admin, as well as the supply chain partners can track the package status every step of the way. | Add trace to a parcel/container,
Track a parcel |\n| _Step 6_. At each hub, the packages undergo the sortation process and may be reassigned to other containers. | Create a container,
Add parcel(s) to a container,
Close a container,
Add trace to a container |\n| _Step 7_. The store admin and the consumer, as well as the supply chain partners can track the package until it arrives at the destination hub.
After the package arrives at the destination hub, we prepare it for the last mile delivery.
The proof of delivery is pushed by the last mile provider and attached to the package in the platform. | Add trace to a parcel/container,
Track a parcel,
Add attachment to parcel |\n\n### Start using the API\n\nYou can easily implement the API for your online store or delivery solution.\n\n1. Access the API collection at\n \n edeveloper.shipa.com\n \n and give it a try in Postman. Use this documentation as an all-in-one guide to get quickly started with the API.\n \n2. Ready to implement the API? Contact us at [edeveloper@shipa.com](https://mailto:edeveloper@shipa.com) to start the onboarding process.\n \n3. You’ll get a Postman collection along with a key. In **Headers**, add **PartnerKey** and enter the key.\n \n \n \n4. Try calling the methods as explained in this documentation. \n `When calling a method, in the method URL, replace {{ExtUrl}} with https://sb.ecommerceapi.shipa.com`\n \n\n### Let’s get started!\n\nChoose a method that you’re interested in:\n\n- [Create a parcel](#a84a3368-eb38-40c5-8110-4792ad997a71)\n \n- [Create a container](#e928cfa2-8890-4c15-9d5c-03980d58d4c4)\n \n- [Add parcel(s) to a container](#61adff50-dc63-46ec-a882-826355d0fa9d)\n \n- [Close a container](#6f8bc9b0-38ab-43a4-9ff5-36106774eda6)\n \n- [Track a parcel](#a689b4db-15a8-445f-82c8-f7420d91d31a)\n \n- [Add trace to a parcel](#0f2122e3-eb30-4b79-b5a4-3f79f8622061)\n \n- [Add trace to a container](#62bafcae-4789-48d2-aaea-f5dd85881c58)\n \n- [Generate a parcel label](#238a5d49-0ec7-4223-ab31-1eed35d7e58f)\n \n- [Generate a container label](#ae193ac7-7be9-45de-a98b-e88fa866e87c)\n \n- [Add attachment to parcel](#e1025b9b-9efe-462f-9a3b-4c0ad06a1fcc)\n \n- [Add attachment to container](#6d054231-f700-4f9f-ab4e-b8417b9ecf99)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6384192","collectionId":"622d73de-d94c-464f-9af3-a75539fc0b80","publishedId":"SVmyRxQ7","public":true,"publicUrl":"https://edeveloper.shipa.com","privateUrl":"https://go.postman.co/documentation/6384192-622d73de-d94c-464f-9af3-a75539fc0b80","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2026-03-26T05:13:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/781cd344654a627b4f175b1a8c1acf7acf6ca7076d499c6c4f46d51b6ddc91ce","favicon":"https://res.cloudinary.com/postman/image/upload/v1568552485/team/lbtearuej8ekjcparwdk.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://edeveloper.shipa.com/view/metadata/SVmyRxQ7"}