Use these APIs to create and manage orders, products, ASNs, and more across Sprint's logistics platform.
\nOur API provides a robust suite of tools designed to help merchants seamlessly integrate their e-commerce platforms with our logistics engine.
\nBy using this API, you can automate your supply chain—from product creation and inventory management to real-time order processing and shipment tracking.
\nOrder Management: Programmatically create and retrieve order details.
\nProduct Catalog: Synchronize your product list and manage item specifications.
\nShipment Tracking: Access real-time tracking information and delivery statuses via our shipment endpoints.
\nWe provide two distinct environments. We strongly recommend completing your development and testing in the Staging environment before moving to Production.
\nThe Sprint Logistics API uses Basic Authentication. To authenticate your requests, you must provide your unique API Key and Password in the request header.
Header Example:Authorization: Basic
If you do not have your API credentials yet, please contact your Sprint Logistics account manager.
\nProtocol: All requests must be made over HTTPS.
\nFormat: The API accepts and returns data in JSON format.
\nTimezones: All timestamps are returned in UTC unless otherwise specified.
\nVariables you'll see:
\nWe offer two environments: Staging, for development and feature testing, and Production, for live operational use. Always validate your integration in Staging before moving to Production.
\nStaging: https://api-staging.sprintlogistics.com
Production: https://api-v2.sprintlogistics.com
When Status is false, the Result field may be null, and the Message field will contain specific information to help you troubleshoot the issue (e.g., \"Invalid API Key\" or \"Product Code not found\").
{\n \"Status\": bool,\n \"Message\": \"string\",\n \"Count\": int,\n \"Result\": { ... }\n}\n\n| Attribute | \r","Value | \r","
|---|---|
| Goods In ID | \r","{{response.Result.GoodsInId}} | \r","
| Customer PO Ref | \r","{{response.Result.CustomerPoRef}} | \r","
| Arrival Date | \r","{{response.Result.ArrivalDate}} | \r","
| Notes | \r","{{response.Result.Notes}} | \r","
| Quantity | \r","{{response.Result.Quantity}} | \r","
| Created Date | \r","{{response.Result.CreatedDate}} | \r","
| Courier Company | \r","{{response.Result.CourierCompany}} | \r","
| Warehouse ID | \r","{{response.Result.WarehouseId}} | \r","
| Total Pallet | \r","{{response.Result.TotalPallet}} | \r","
| Total Product | \r","{{response.Result.TotalProduct}} | \r","
| Total Box | \r","{{response.Result.TotalBox}} | \r","
Creates a new Advanced Shipping Notice (ASN) in the Sprint Logistics system.
\nThis endpoint accepts shipment header information and a list of item lines, and returns an ASN / Goods In identifier and related summary data if successful.
\nUse this endpoint to pre‑advise Sprint Logistics of inbound goods. It records the customer PO reference, expected arrival date, carrier details, and the items (SKUs, quantities, batches, expiries) that will be received into the specified warehouse.
\nHigh‑level workflow:
\nClient system prepares ASN data (PO reference, dates, carrier, warehouse, and item lines).
\nClient calls this endpoint with a JSON body (see fields below).
\nIf the payload is valid, the API creates the ASN / Goods In record and returns details such as GoodsInId, totals, and echo of key fields.
If required data is missing or invalid, the API returns an error with a message describing the problem.
\nMethod: POST
Top‑level object properties details:-
\nListItems item properties:
Use this table together with your domain model to ensure all required fields (including any item‑level description field that your implementation expects) are sent.
\nThe request body is JSON with the following main fields:
\n{\n \"CustomerPoRef\": \"string\",\n \"ArrivalDate\": \"string\", // ISO 8601 date-time with timezone offset (e.g. 2025-12-25T10:25:46.224538+01:00)\n \"Notes\": \"string\",\n \"Quantity\": int, \n \"CreatedDate\": \"string\", // ISO 8601 date-time with timezone offset (e.g. 2024-08-15T10:25:46.224538+01:00)\n \"CourierCompany\": \"string\",\n \"CourierOrTransportRef\": \"string\",\n \"WarehouseId\": \"string\", // GUID/UUID (e.g. 9F9BFBF6-412C-41C3-8ABE-C8166DBF0CC5)\n \"ListItems\": [\n {\n \"Sku\": \"string\",\n \"Description\": \"string\",\n \"TotalQuantity\": int,\n \"BatchCode\": \"string\",\n \"ExpiryDate\": \"string\" // ISO 8601 date (YYYY-MM-DD), e.g. 2025-09-30\n }\n ]\n}\n\nOn success (HTTP 200), the API returns a structure similar to:
{\n \"Status\": bool,\n \"Message\": \"string\",\n \"Count\": int,\n \"Result\": {\n \"GoodsInId\": \"string\", // GUID/UUID (e.g. 1e670cdd-908d-47f8-bca2-b3e0d45bf30a)\n \"CustomerPoRef\": \"string\",\n \"ArrivalDate\": \"string\", // ISO 8601 date-time with timezone offset (e.g. 2025-12-25T09:25:46.224538+00:00)\n \"Notes\": \"string\",\n \"Quantity\": int,\n \"CreatedDate\": \"string\", // ISO 8601 date-time with timezone offset (e.g. 2024-08-15T10:25:46.224538+01:00)\n \"CourierCompany\": \"string\",\n \"CourierOrTransportRef\": \"string\",\n \"TotalPallet\": int,\n \"TotalProduct\": int,\n \"TotalBox\": int,\n \"WarehouseId\": \"string\", // GUID/UUID (e.g. 9f9bfbf6-412c-41c3-8abe-c8166dbf0cc5)\n \"ListItems\": [\n {\n \"Sku\": \"string\",\n \"Item2Id\": \"string\", // GUID/UUID (e.g. 8dc062d3-2fd4-4ba0-ba55-349fdf00b320)\n \"Description\": \"string\",\n \"TotalQuantity\": int,\n \"BatchCode\": \"string\",\n \"ExpiryDate\": \"string\", // ISO 8601 date-time (e.g. 2025-09-30T00:00:00) OR date-only (YYYY-MM-DD) if you standardise it\n \"SerialNumberRequired\": bool\n }\n ]\n }\n} \n\nIf required fields are missing or invalid, the API returns a 400 Bad Request with a JSON error body.
Example observed 400 response:
\n{\n \"Status\": bool\n \"Message\": \"string\"\n}\n\nRetrieves a paginated list of ASNs (Advanced Shipping Notices) with optional filters.
\nGET /api/asn
pageNumber (integer, optional)
Description: The page index to retrieve for the ASN list.
\nUsage: Used for pagination in combination with pageSize.
Example: 1
pageSize (integer, optional)
Description: The number of ASNs to return per page.
\nUsage: Used for pagination in combination with pageNumber.
Known examples (from similar GetASN's requests in the Sprint Logistics REST API collection): 1, 10, 50
goodsInId (string, optional)
Description: Filters the ASNs by a specific Goods In record identifier.
\nType: GUID/UUID string or numeric identifier (based on known usage in similar GetASN's requests).
Known examples:
\n5dcf9b63-82fe-49a6-857b-806f9dc7b301
1
status (string, optional)
Description: Filters the ASNs by their processing status.
\nKnown example values (from similar GetASN's requests in the Sprint Logistics REST API collection):
Complete
Booked
\n\nKnown query parameter keys and example values are derived from similar saved requests named
\nGetASN'sin the Sprint Logistics REST API collection, as well as the last successful 200 OK response for this request.
The response returns a JSON object with the following top-level fields:
\nStatus (boolean)
Indicates whether the operation was successful.
\nExample: true
Message (string)
A human-readable status message.
\nExample: \"Success\"
Count (integer)
The number of ASN records returned in the Result array for the current page.
Example: 1
Result (array of objects)
Result)Each ASN object includes (non-exhaustive):
\nGoodsInId (string)
Unique identifier of the Goods In record.
\nExample: \"fc714f2f-288b-4de4-ab8d-6cf38a1c8a52\"
CustomerPoRef (string)
Customer purchase order reference.
\nExample: \"UK_201025\"
AsnNumber (string)
The ASN reference/number.
\nExample: \"ASN-HES-2911623\"
CreatedDateTime (string, date)
Date the ASN was created.
\nExample: \"2025-10-29\"
Status (string)
\"Complete\").Notes (string or null)
ArrivalDate (string, date)
Expected or actual arrival date.
\nExample: \"2025-10-31\"
TrackingNumber (string)
Carrier tracking number, if available.
\nExample: \"83223\"
Items (array of objects)
Items)Each item object within Items includes (non-exhaustive):
GoodsInProductId (string)
ItemCode (string)
Product code/SKU.
\nExample: \"HAON011ED\"
ItemDescription (string)
Human-readable product description.
\nExample: \"YACHT CORD - GREEN\"
TotalQty (integer)
Total quantity expected for this line.
\nExample: 50
ReceivedQty (integer)
Quantity received so far for this line.
\nExample: 50
BatchCode (string or null)
ExpiryDate (string or null)
BoxQuantity (integer)
Quantity per box or packaging unit.
\nExample: 0
Barcode (string)
Product barcode/UPC/EAN.
\nExample: \"8436603567718\"
This description is based on the last observed 200 OK response body for this request, combined with known query parameter options from similar GetASN's requests in the Sprint Logistics REST API collection.
GET {{URL}}/api/asn?pageNumber=1&pageSize=10&status=Booked&goodsInId=5dcf9b63-82fe-49a6-857b-806f9dc7b301\n\n{\n \"Status\": bool,\n \"Message\": \"string\",\n \"Count\": int,\n \"Result\": [\n {\n \"GoodsInId\": GuidID,\n \"CustomerPoRef\": \"string\",\n \"AsnNumber\": \"string\",\n \"CreatedDateTime\": \"string\"//2025-12-23,\n \"Status\": \"string\",\n \"Notes\": \"string\",\n \"ArrivalDate\": \"string\"//2025-12-25,\n \"TrackingNumber\": \"string\",\n \"LastUpdatedOn\": datetime//2025-12-23T11:38:15,\n \"Items\": [\n {\n \"GoodsInProductId\": GuidId,\n \"ItemCode\": \"string\",\n \"ItemDescription\": \"string\",\n \"TotalQty\": int,\n \"ReceivedQty\": int,\n \"BatchCode\": \"string\",\n \"ExpiryDate\": \"string\"//2025-09-30T00:00:00,\n \"BoxQuantity\": int,\n \"Barcode\": \"string\"\n }\n ]\n }\n ]\n}\n\nEnsure that the goodsInId provided is valid and corresponds to an existing goods in record.
The response may include multiple ASNs depending on the pagination and filtering criteria.
\nIf no ASNs match the criteria, the Count will be 0, and the Result array will be empty.
Deletes an existing ASN (Advance Shipping Notice) from the Sprint Logistics system.
\nMethod: DELETE
URL: /api/asn/remove
This operation is irreversible once completed.
goodsInId (string, required)
The unique identifier of the ASN / Goods-In record to delete.
\nExample: ada6ad0e-b8c1-40e7-9e8e-d43ca0e4c727
The request will fail if goodsInId does not exist or has already been removed.
200/204 – ASN was successfully deleted (or marked as removed).
\n400 – Invalid or missing goodsInId.
401/403 – Authentication or authorization failure.
\n404 – ASN with the specified goodsInId was not found.
Use this endpoint with caution in non-test environments, as it can impact downstream warehouse and logistics processes.
\n","urlObject":{"path":["api","asn","remove"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"c02f6f06-adbe-46f1-9a6c-2c7b0dd96b09","name":"DeleteAsn","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{URL}}/api/asn/remove?goodsInId=ada6ad0e-b8c1-40e7-9e8e-d43ca0e4c727","host":["{{URL}}"],"path":["api","asn","remove"],"query":[{"key":"goodsInId","value":"ada6ad0e-b8c1-40e7-9e8e-d43ca0e4c727"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b9f4888f-769c-40fa-ac42-8a7f3cc4cefa"}],"id":"d39ca000-d9cd-499e-bc7d-0aade4432564","description":"The ASN (Advanced Shipment Notice) endpoints allow you to create, retrieve, and delete inbound shipment pre‑advice records in Sprint Logistics.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"06d03197-0ec4-4697-8a2c-b2b54da60bd7","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"581872d0-2d3e-403a-a7d2-37c94951650c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"d39ca000-d9cd-499e-bc7d-0aade4432564"},{"name":"Countries","item":[{"name":"Country List","id":"61e483d3-9346-4f55-8067-1d4b53ec6c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/countries","description":"Purpose
Retrieve a paginated list of available countries from the Sprint Logistics API.
Method & URLGET /api/countries?page={{page}}
Query Parameters
\npage (integer, required): Zero-based index of the results page to retrieve. Example: 0 for the first page.Responses
\n200 OK: Returns a JSON array or paginated object containing country records.
400 Bad Request: The page value is invalid (e.g., negative or non-numeric).
401 Unauthorized / 403 Forbidden: Missing or invalid Basic auth credentials.
5xx Server Error: An unexpected error occurred on the server.
Retrieves a paginated list of carriers from the Sprint Logistics REST API.
\nSends a GET request to /api/carrier/.
Returns carrier records in JSON format.
\nSupports pagination using the page and pageSize query parameters.
Endpoint example:
\n/api/carrier/?page=0&pageSize=100\n\npage (optional, default 0)
Type: integer
\nDescription: Zero-based page index to retrieve.
\npageSize (optional, default 100)
Type: integer
\nDescription: Maximum number of carrier records to return on a single page.
\nTo fetch the first 100 carriers, send the request with:
\npage=0
pageSize=100
This request retrieves a paginated list of orders from the Sprint Logistics REST API. It is typically used by warehouse, operations, or integration services to fetch current order data, optionally filtered by status, airway bill (AWB) number, or last update timestamp.
\nQuery parameters
\nGET /api/orders?page=1&pageSize=100\n\nRetrieves a single order by its reference identifier.
\nHTTP Method: GET
URL Structure: /api/orders/ref?ID={orderReference}
{{URL}} is provided by the active environment (for example, the base URL of the Sprint API).
/api/orders/ref is the resource path for looking up an order by reference.
Query Parameters:
\nID (string, required): The unique reference for the order. Example values: staging-170982, Yt65653, TYRETEIQW2333. The endpoint returns the order that matches this reference.Retrieves order details from Sprint Logistics by customer reference ID.
\nURL patternGET /api/orders/ref?ID={customerRef}
{{URL}} is the base URL from the active environment (for example, staging or production).
ID is a required query parameter that represents the customer reference for the order (e.g., Yt65653).
Authentication
\nUses HTTP Basic authentication.
\nThe Authorization header must contain a valid Base64-encoded API key/secret pair.
In this collection, the header is already preconfigured; ensure the active environment has correct credentials.
\nQuery parameters
\nID (string, required): Customer reference used to look up the order.
Yt65653, TYRETEIQW2333, staging-170982.Successful response (200)
On success, the endpoint returns a JSON object with overall status and detailed order information.
Example:
\n{\n \"Status\": bool,\n \"Message\": \"string\",\n \"Count\": int,\n \"Result\": {\n \"AWB\": \"string\",\n \"Status\": \"string\",\n \"OrderStatus\": \"string\",\n \"AttnOf\": \"string\",\n \"Telephone\": \"string\",\n \"EmailAddr\": \"string\",\n \"CompanyName\": \"string\",\n \"Address1\": \"string\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"City\": \"string\",\n \"State\": \"\",\n \"PostCode\": \"string\",\n \"CountryID\": null,\n \"CountryName\": \"string\",\n \"CountryCode\": \"string\",\n \"SpecialInstructions\": \"\",\n \"PackingNote\": \"\",\n \"CustomerRef1\": \"string\",\n \"CustomerRef2\": \"\",\n \"Carrier\": \"\",\n \"Tracking\": \"\",\n \"CourierService\": null,\n \"CreatedDate\": null,\n \"ExpectedDeliveryDate\": null,\n \"ExpectedShipmentDate\": null,\n \"ReturnTracking\": null,\n \"OrderType\": \"string\",\n \"BrandName\": \"string\",\n \"ServiceLevel\": null,\n \"IOSSNumber\": null,\n \"IOSSCountryOfOrigin\": null,\n \"FulfilledDate\": null,\n \"OrderState\": \"string\",\n \"TrackingInfo\": null,\n \"StockOrderItems\": [\n {\n \"SKU\": \"string\",\n \"Quantity\": int,\n \"Batch\": \"string\",\n \"Expiry\": \"string\",\n \"HsCode\": \"string\",\n \"CountryOfOrigin\": \"string\",\n \"SalesValue\": \"string\",\n \"SerialNumbers\": \"string\"\n }\n ]\n }\n}\n\nCreates a unique order in the Sprint Logistics system.
\n{\n \"Status\": true,\n \"Message\": \"string\",\n \"Count\": 0,\n \"Result\": {\n \"AWB\": \"string\",\n \"Status\": \"string\",\n \"OrderStatus\": \"string\",\n \"AttnOf\": \"string\",\n \"Telephone\": \"string\",\n \"EmailAddr\": \"string\",\n \"CompanyName\": \"string\",\n \"Address1\": \"string\",\n \"Address2\": \"string\",\n \"Address3\": \"string\",\n \"City\": \"string\",\n \"State\": \"string\",\n \"PostCode\": \"string\",\n \"CountryID\": \"string\",\n \"CountryName\": \"string\",\n \"CountryCode\": \"string\",\n \"SpecialInstructions\": \"string\",\n \"PackingNote\": \"string\",\n \"CustomerRef1\": \"string\",\n \"CustomerRef2\": \"string\",\n \"CustomerRef3\": \"string\",\n \"Carrier\": \"string\",\n \"Tracking\": \"string\",\n \"CourierService\": \"string\",\n \"CreatedDate\": \"2026-03-27T10:10:19.328Z\",\n \"ExpectedDeliveryDate\": \"string\",\n \"ExpectedShipmentDate\": \"string\",\n \"ReturnTracking\": \"string\",\n \"OrderType\": \"string\",\n \"BrandName\": \"string\",\n \"ServiceLevel\": \"string\",\n \"IOSSNumber\": \"string\",\n \"IOSSCountryOfOrigin\": \"string\",\n \"FulfilledDate\": \"string\",\n \"OrderState\": \"string\",\n \"TrackingInfo\": {\n \"HAWB\": \"string\",\n \"Carrier\": \"string\",\n \"TrackingID\": \"string\",\n \"TrackingLink\": \"string\",\n \"SupplierDispatchedDate\": \"string\",\n \"SupplierDeliveryDate\": \"string\",\n \"ServiceLevel\": \"string\",\n \"LineItems\": [\n {\n \"Sku\": \"string\",\n \"Quantity\": 0,\n \"Batch\": \"string\",\n \"ExpiryDate\": \"string\",\n \"SerialNos\": \"string\"\n }\n ]\n },\n \"StockOrderItems\": [\n {\n \"SKU\": \"string\",\n \"Quantity\": 0,\n \"Batch\": \"string\",\n \"Expiry\": \"string\",\n \"CountryOfOrigin\": \"string\",\n \"SalesValue\": 0,\n \"HsCode\": \"string\"\n }\n ]\n }\n}\n\n{\n \"success\": false,\n \"message\": \"string\"\n}\n\nCancels an existing order for the given customer reference.
\nMethod: POST
URL: /api/orders/cancelorder
Auth: Basic Authentication (username/password)
\nBody: None (all data is provided via query parameters)
\ncustRef (string, required)
Customer/order reference used to identify which order should be cancelled.
\nExample: staging-170982
Uses Basic Auth.
\nEnsure valid credentials are configured in the request or inherited from the parent (e.g. {{BOLT_TEST_USER_KEY}} / {{BOLT_TEST_PASSWORD}} in the active environment).
200 OK – Order successfully cancelled. Response body typically includes confirmation/details of the cancelled order.
\n400 Bad Request – Missing or invalid custRef, or the order cannot be cancelled in its current state.
401 Unauthorized – Basic Auth credentials are missing or invalid.
\n404 Not Found – No order found for the provided custRef.
5xx Server Error – An error occurred on the server while attempting to cancel the order.
\nOverview
\nUpdates an existing order in the Sprint API. This endpoint allows you to modify customer contact details, shipping address, special instructions, and (optionally) the individual line items in the order.
\nAuthentication
\nThis endpoint is secured. Typical usage in this collection assumes:
\nAn authenticated session or API credentials configured in the active environment (for example, username/password or an API key such as BOLT_TEST_USER_KEY / BOLT_TEST_PASSWORD).
Authentication headers or authorization helpers are applied at the collection or folder level and inherited by this request.
\nEnsure you have the correct environment selected (for example, Staging) and that authentication variables are populated before sending the request.
\nHTTP Request
\nMethod: POST
URL: /api/orders/update
Body type: raw JSON
The request body is a JSON object. Below is the structure based on the current example payload.
\n{\n \"ExternalCustomerReference\": \"string\",\n \"AttnOf\": \"string\",\n \"Telephone\": \"string\",\n \"EmailAddr\": \"string\",\n \"Address1\": \"string\",\n \"Address2\": \"string\",\n \"Address3\": \"\",\n \"State\": \"string\",\n \"PostCode\": \"string\",\n \"CountryID\": \"string\",\n \"CountryCode\": \"string\",\n \"SpecialInstructions\": \"string\",\n \"PackingNote\": \"string\",\n \"ServiceCode\": \"string\",\n \"IsLineItemsUpdated\": bool,\n \"StockOrderItems\": [\n {\n \"ProductID\": int,\n \"SKU\": \"string\",\n \"Quantity\": int,\n \"Batch\": null,\n \"Expiry\": null\n },\n {\n \"ProductID\": int,\n \"SKU\": \"string\",\n \"Quantity\": int,\n \"Batch\": null,\n \"Expiry\": null\n }\n ]\n}\n\nExternalCustomerReference string
Client-side or external system identifier that ties the order to a customer or upstream system. Used to locate and update the target order.
AttnOf string
Contact name for the order (e.g., recipient or attention-of line on the label).
Telephone string
Contact phone number for delivery questions or notifications. Include country code where applicable.
EmailAddr string
Contact email for order or shipment notifications.
Address1 string
Primary address line (typically building number and street).
Address2 string (optional)
Secondary address information (e.g., suite, apartment, floor).
Address3 string (optional)
Additional address information when needed; can be empty.
State string
State, province, or region of the delivery address.
PostCode string
Postal/ZIP code for the delivery address.
CountryID string
Internal country identifier (often a code used by the underlying system, for example GB).
CountryCode string
Standardized country code (e.g., ISO 3166-1 alpha-3 such as GBR).
SpecialInstructions string (optional)
Free-text delivery instructions for the carrier (e.g., where to leave the package).
PackingNote string (optional)
Notes related to how items should be packed or handled.
ServiceCode string
Code representing the shipping or service level for the order (e.g., next-day, timed delivery). Must match a supported service in your Sprint configuration.
IsLineItemsUpdated boolean
Indicates whether the line items (StockOrderItems) are being updated with this request. When true, the API will process the provided items as an updated set.
StockOrderItems array (optional but recommended when `IsLineItemsUpdated` is `true`) Collection of line items in the order to be updated. #### `StockOrderItems[]` item fields Each object in `StockOrderItems` describes a single order line: - **`ProductID`** `number` Internal identifier of the product/stock item. - **`SKU`** `string` Stock-keeping unit code for the product. - **`Quantity`** `number` Quantity of this product on the order. - **`Batch`** `string|null` (optional) Batch or lot identifier, if applicable to your stock control; can be `null` if not used. - **`Expiry`** `string|null` (optional) Expiry date for perishable or regulated items, if required by your stock setup; can be `null` when not applicable.
This endpoint updates the processing state of an existing order by pausing or unpausing it based on the Flag value.
Method: POST
URL: /api/orders/state
Request Body
\n{\n \"ExternalCustomerReference\": \"string\",\n \"Reason\": \"string\",\n \"Flag\": int\n}\n\nExternalCustomerReference string
Unique external identifier of the order whose state you want to change.
Reason string
Human‑readable explanation for changing the order state (e.g., \"Customer requested order hold\"). This is typically logged/audited.
Flag integer
Controls whether the order is paused or unpaused.
Typical behavior (based on current usage and naming):
\nA value used in examples (e.g., 3) appears to represent placing the order on hold / pause.
Other values may represent unpausing or additional states, but these are implementation‑specific to the backend service and not fully documented here.
\nRetrieves a single product from the Sprint Products API using its internal product ID.
\nGET /api/product?ID=GuidID as string value
This request is the ID-based variant of the product lookups, complementing:
\nGetProductById – looks up by product by id only.Use GetProductByID when you know the internal guid product ID and want the details for that specific product.
All parameters are sent as query string values on /api/product.
This request uses HTTP Basic Authentication, consistent with the rest of the Sprint Api Documentation collection:
\nUsername: {{api_key}}
Password: {{api_password}}
The response shape is consistent with other endpoints in this collection and is typically wrapped in the standard model response:
\n{\n \"Status\": bool,\n \"Message\": \"string\",\n \"Count\": int,\n \"Result\": [\n {\n // product fields (ID, SKU, description, stock, etc.)\n }\n ]\n}\n\nGET {{URL}}/api/product?ID=6F7894CA-6CDA-43DF-BD41-5ECA361F9A6A\nAuthorization: Basic adsfasfasdfasd\n\nQuery Parameters
\nStatus: 200 OK
{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 0,\n \"Result\": {\n \"ID\": 1118700,\n \"ProductId\": \"6f7894ca-6cda-43df-bd41-5eca361f9a6a\",\n \"SKU\": \"008748334\",\n \"Date\": \"2025-04-25T11:46:30.07\",\n \"MinimumStockLevel\": null,\n \"ProductDescription\": \"test Product Added as new\",\n \"ItemsPerCase\": null,\n \"Weight\": null,\n \"Height\": null,\n \"Width\": null,\n \"Length\": null,\n \"Barcode\": null,\n \"IsActive\": true,\n \"WarehouseStock\": []\n }\n}\n\n\n\n","urlObject":{"path":["api","product"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e7e994d-1b1a-4d47-bab7-13752523ede3"},{"name":"GetProductBySku","id":"6da08fc0-dd84-4d72-abf9-c48d2f490eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/product","description":"ID vs ProductId: The
\nIDquery parameter (a GUID string) maps directly toProductIdin the response. The integerIDfield in response payload is a legacy identifier that is being phased out — avoid building new logic against it and preferProductIdinstead.
Retrieves products from the Sprint Products API using a SKU.
\nGET /api/product?sku={sku}
Use GetProductBySku when you know the product SKU and want to retrieve the details for that specific product.
All parameters are sent as query string values on /api/product?sku={sku}
This request uses HTTP Basic Authentication, consistent with the rest of the Sprint Api Documentation collection:
\nUsername: {{api_key}}
Password: {{api_password}}
The Authorization header is sent in the following format:
\nAuthorization: Basic <base64(username:password)>\n\nGET /api/product/productsbysku?sku=12006 HTTP/1.1\nHost: {{URL}}\nAuthorization: Basic <base64(username:password)>\n\nStatus: 200 OK
{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 165,\n \"Result\": [\n {\n \"ID\": 1118700,\n \"ProductId\": \"6F7894CA-6CDA-43DF-BD41-5ECA361F9A6A\",\n \"SKU\": \"008748334\",\n \"Date\": \"2025-04-25 11:46:30\",\n \"MinimumStockLevel\": 0,\n \"ProductDescription\": \"test Product Added as new\",\n \"ItemsPerBox\": null,\n \"ProductCategory\": null,\n \"SubCategory\": null,\n \"UnitValue\": null,\n \"Language\": null,\n \"UnitWeightGrams\": null,\n \"HsCodes\": null,\n \"CountryOfOrigin\": null,\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"BatchExpiry\": [\n {\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"QtyAvailable\": 0,\n \"TrackingNumber\": null,\n \"Status\": null\n }\n ],\n \"LastUpdatedOn\": \"2025-06-16T13:28:04\",\n \"ReplenishmentDate\": null,\n \"Notes\": \"\",\n \"QtyAvailable\": 0,\n \"NonSellableQuantity\": 0,\n \"ShortStatus\": null,\n \"IsBatchCodeReq\": false\n },\n {\n \"ID\": 1137449,\n \"ProductId\": \"8DC062D3-2FD4-4BA0-BA55-349FDF00B320\",\n \"SKU\": \"12006\",\n \"Date\": \"2025-12-23 11:38:15\",\n \"MinimumStockLevel\": 0,\n \"ProductDescription\": \"12006\",\n \"ItemsPerBox\": null,\n \"ProductCategory\": null,\n \"SubCategory\": null,\n \"UnitValue\": \"0.00\",\n \"Language\": null,\n \"UnitWeightGrams\": null,\n \"HsCodes\": \"\",\n \"CountryOfOrigin\": null,\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"BatchExpiry\": [\n {\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"QtyAvailable\": 0,\n \"TrackingNumber\": null,\n \"Status\": null\n }\n ],\n \"LastUpdatedOn\": \"2025-12-23T13:54:50\",\n \"ReplenishmentDate\": null,\n \"Notes\": \"\",\n \"QtyAvailable\": 0,\n \"NonSellableQuantity\": 0,\n \"ShortStatus\": null,\n \"IsBatchCodeReq\": false\n },\n {\n \"ID\": 1066198,\n \"ProductId\": \"18F9DFD0-F91E-4914-B0E9-9AD299B71F43\",\n \"SKU\": \"5713504000118\",\n \"Date\": \"2024-05-08 00:35:18\",\n \"MinimumStockLevel\": 0,\n \"ProductDescription\": \"CU Backrest Wide Track\",\n \"ItemsPerBox\": null,\n \"ProductCategory\": null,\n \"SubCategory\": null,\n \"UnitValue\": \"0.00\",\n \"Language\": null,\n \"UnitWeightGrams\": null,\n \"HsCodes\": null,\n \"CountryOfOrigin\": null,\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"BatchExpiry\": [\n {\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"QtyAvailable\": 191,\n \"TrackingNumber\": null,\n \"Status\": null\n },\n {\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"QtyAvailable\": 1,\n \"TrackingNumber\": 66749,\n \"Status\": null\n }\n ],\n \"LastUpdatedOn\": \"2025-09-23T06:04:06\",\n \"ReplenishmentDate\": null,\n \"Notes\": \"\",\n \"QtyAvailable\": 356,\n \"NonSellableQuantity\": 0,\n \"ShortStatus\": null,\n \"IsBatchCodeReq\": false\n }\n // ... additional results truncated (165 total)\n ]\n}\n\nThe Product List endpoint retrieves a paginated list of products from the Sprint API. It supports filtering by SKU, product ID, and last-updated timestamps, making it suitable for both full product syncs and incremental delta updates.
\nGET {{URL}}/api/product\n\nThis endpoint requires Basic Authentication. Encode your credentials and pass them in the Authorization header:
Authorization: Basic {{api_key}}:{{api_password}}\n\n\n\nCredentials are Base64-encoded in the format
\napi_key:api_password. Ensure your credentials are kept secure and never exposed in client-side code.
\n\nAll query parameters are optional and can be combined. For large catalogs, always use
\npageandpagesizetogether to paginate through results efficiently.
GET {{URL}}/api/product?page=1&pagesize=1&lastUpdatedOn=2025-08-19T10:00:29\n\nStatus: 200 OK
{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 165,\n \"Result\": [\n {\n \"ID\": 1137449,\n \"ProductId\": \"8DC062D3-2FD4-4BA0-BA55-349FDF00B320\",\n \"SKU\": \"12006\",\n \"Date\": \"2025-12-23 11:38:15\",\n \"MinimumStockLevel\": 0,\n \"ProductDescription\": \"12006\",\n \"ItemsPerBox\": null,\n \"ProductCategory\": null,\n \"SubCategory\": null,\n \"UnitValue\": \"0.00\",\n \"Language\": null,\n \"UnitWeightGrams\": null,\n \"HsCodes\": \"\",\n \"CountryOfOrigin\": null,\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"BatchExpiry\": [\n {\n \"BatchCode\": null,\n \"ExpiryDate\": null,\n \"QtyAvailable\": 0,\n \"TrackingNumber\": null,\n \"Status\": null\n }\n ],\n \"LastUpdatedOn\": \"2025-12-23T13:54:50\",\n \"ReplenishmentDate\": null,\n \"Notes\": \"\",\n \"QtyAvailable\": 0,\n \"NonSellableQuantity\": 0,\n \"ShortStatus\": null,\n \"IsBatchCodeReq\": false\n }\n ]\n}\n\nResult[] — Product Object FieldsPagination: The Count field reflects the total number of matching records, not just the current page. Use it alongside pagesize to calculate the total number of pages: totalPages = Math.ceil(Count / pagesize).
Delta Sync: Use lastUpdatedOn or LastUpdatedOn to fetch only products that have changed since your last sync, reducing payload size and improving performance.
Filtering: sku and ID filters are useful for looking up a specific product without fetching the full list.
Stock Availability: Use QtyAvailable for sellable stock. NonSellableQuantity represents stock that is physically present but not available for orders (e.g., quarantined or reserved).
Batch-Tracked Products: If IsBatchCodeReq is true, the product requires a batch code for fulfilment. Check the BatchExpiry array for batch-level availability and expiry details.
Authentication: Credentials must be Base64-encoded. Use environment variables {{api_key}} and {{api_password}} to avoid hardcoding sensitive values.
Creates a new product in the Sprint API. Use this endpoint to register a product that can later be referenced in orders, shipments, or inventory flows.
\nThis endpoint requires Basic Authentication.
\nCredentials are provided via environment variables:
\nUsername: {{BOLT_TEST_USER_KEY}}
Password: {{BOLT_TEST_PASSWORD}}
The encoded credentials must be sent in the Authorization header:
Authorization: Basic <base64(username:password)>\n\nAll fields are sent as a JSON object in the request body.
\n{\n \"ProductDescription\": \"Batch Code Testing\",\n \"ProductCode\": \"TestProduct_Sendoso1\",\n \"UnitValue\": 19.95,\n \"Notes\": \"Fragile – handle with care\",\n \"HSCodes\": \"84711212130\",\n \"CountryOfOrigin\": \"GBR\",\n \"Barcode\": \"5901234123457\",\n \"IsBatchCodeReq\": true,\n \"BatchCode\": \"21212\"\n}\n\nStatus: 200 OK
{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 1,\n \"Result\": {\n \"ID\": \"c7ee2c69-4d60-4c36-a7ac-0c076c942036\",\n \"ProductDescription\": \"Batch Code Testing\",\n \"SKU\": \"Test001\",\n \"UnitValue\": 19.95,\n \"Notes\": \"Fragile – handle with care\",\n \"HsCodes\": \"84711212130\",\n \"CountryOfOrigin\": \"GBR\",\n \"UnitWeightGrams\": 0,\n \"Barcode\": \"5901234123457\"\n }\n}\n\nProductCode must be unique — submitting a duplicate code may result in an error.
Provide HSCodes and CountryOfOrigin for any products intended for international shipping to avoid customs delays.
BatchCode must be included in the request body when IsBatchCodeReq is set to true.
UnitWeightGrams is returned in the response but is not a request field — it defaults to 0 and can be updated via a separate endpoint.
The Result.ID (UUID) returned in the response uniquely identifies the created product and should be stored for use in subsequent API calls (e.g., order creation, shipment referencing).
Updates customs and commercial details for an existing product record. Use this endpoint when you need to modify a product's HS code, country of origin, declared unit value, description, or notes — for example, before including the product in an international shipment.
\n\n\nNote: This endpoint updates customs/commercial attributes only. To create a new product, use Product Create (
\nPOST /api/product/create). To look up a product, use GetProductByID or GetProductBySku.
PUT {{URL}}/api/product/update\n\nSend a JSON object with the following fields:
\n{\n \"ProductID\": \"6F7894CA-6CDA-43DF-BD41-5ECA361F9A6A\",\n \"HsCode\": \"abcv\",\n \"CountryOfOrigin\": \"GB\",\n \"ProductDescription\": \"this is testing\",\n \"UnitValue\": \"1.4\",\n \"Notes\": \"this is notes\"\n}\n\nStatus: 200 OK
{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 1,\n \"Result\": {\n \"ID\": 1118700,\n \"ProductId\": \"6f7894ca-6cda-43df-bd41-5eca361f9a6a\",\n \"SKU\": \"008748334\",\n \"Date\": \"2025-04-25T11:46:30.07\",\n \"MinimumStockLevel\": null,\n \"ProductDescription\": \"this is testing\",\n \"ItemsPerBox\": null,\n \"ProductCategory\": \"\",\n \"UnitValue\": \"1.40\",\n \"Language\": \"\",\n \"CostCentre\": \"\",\n \"UnitWeightGrams\": null,\n \"Misc1\": null,\n \"Misc2\": null,\n \"BatchNExpiry\": [],\n \"LastUpdatedOn\": \"2026-03-17T16:33:27.297\",\n \"Notes\": \"this is notes\",\n \"TotalQuantity\": 0,\n \"AvailableQuantity\": 0,\n \"NonSellableQuantity\": 0,\n \"CountryOfOrigin\": null,\n \"HsCodes\": null,\n \"ProductTrackingNo\": null\n }\n}\n\nProductID must be a valid GUID string. Use the ProductId field from any product lookup response.
Only the fields listed above are accepted by this endpoint. Fields such as SKU, Barcode, IsBatchCodeReq, and UnitWeightGrams cannot be modified here.
CountryOfOrigin and HsCodes in the response may appear as null immediately after the update depending on server-side processing — this is expected behaviour.
UnitValue is submitted as a string (e.g., \"1.4\") and returned as a string-encoded decimal (e.g., \"1.40\").
Creates a new return for an order and (optionally) generates a carrier return label.
\nBase URL
\nThe base URL is provided by the {{URL}} environment variable.
Full endpoint: /api/returns/generatereturnlabel.
Authentication & Headers
\nAuthorization (required): Basic auth header for the API.
Content-Type (required): application/json.
Request Body (JSON)
All fields are sent in a single JSON object. Unless noted as optional, fields are typically required by the API and/or your business process.
Top‑level fields
\nExternalOrderReferenceNumber (string, required)
Your external order reference or order ID. Used to link the return to the original order.
CustomerReference (string, required)
Customer-facing reference (e.g., web order number) that will be attached to the return.
RMANumber (string, required)
Return merchandise authorization (RMA) number for this return.
LuzernRmaNumber (string, optional/partner-specific)
RMA/return identifier used by Luzern or another integration partner.
AttnOf (string, required)
Contact person to whom the return is addressed.
Telephone (string, required)
Contact phone number for the return.
EmailAddr (string, required)
Contact email address for notifications related to the return.
CompanyName (string, optional)
Company name associated with the return address.
Address1 (string, required)
First line of the return street address.
City (string, required)
City for the return address.
PostCode (string, required)
Postal/ZIP code for the return address.
CountryCode (string, required)
ISO country code (for example, GB) for the return address.
ReturnLabel (boolean, required)
Controls whether a return label should be generated as part of this call.
true: Generate a return label.
false: Create the return record without generating a label.
CarrierId (string, optional/conditional)
Identifier of the carrier to be used for the return label. May be required when ReturnLabel is true, depending on your configuration.
LabelType (string, optional/conditional)
Specifies the label type or routing (for example, \"atshop\"). Valid values depend on your carrier/setup and are used only when ReturnLabel is true.
StockOrderItems (array of objects, required)
List of items being returned. Each element describes a single SKU and quantity.
Each StockOrderItems[] element has:
SKU (string, required): The SKU being returned.
Quantity (number, required): Quantity of the SKU to return.
Behavior of ReturnLabel and StockOrderItems
ReturnLabel indicates whether the API should create a carrier return label alongside the return record. When enabled, the service uses address, carrier and label type information to build the label.
StockOrderItems defines the actual items being returned; this array drives the content of the return, quantities to receive back into stock, and what will be associated with any generated return label.
Example body
\n{\n \"ExternalOrderReferenceNumber\": \"string\",\n \"CustomerReference\": \"string\",\n \"RMANumber\": \"string\",\n \"LuzernRmaNumber\": \"string\",\n \"AttnOf\": \"string\",\n \"Telephone\": \"string\",\n \"EmailAddr\": \"string\",\n \"CompanyName\": \"string\",\n \"Address1\": \"string\",\n \"City\": \"string\",\n \"PostCode\": \"string\",\n \"CountryCode\": \"string\",\n \"ReturnLabel\": bool,\n \"CarrierId\": \"\",\n \"LabelType\": \"string\",\n \"StockOrderItems\": [\n {\n \"SKU\": \"string\",\n \"Quantity\": int\n }\n ]\n}\n\nRetrieves a paginated list of return records associated with the authenticated account.
\nThis endpoint returns return data (RMAs) filtered and ordered on the server. It is typically used by back‑office or customer service tools to list existing returns for review, tracking, or reporting.
\npageNumber (integer, required): The 1‑based index of the page to retrieve. Controls which \"slice\" of the overall result set is returned.
pageSize (integer, required): The maximum number of records to include in a single page of results (for example, 10, 20, 30). Higher values return more results per call but may increase response size.
viewStatus (string, optional): When provided (for example, VIEWED), restricts the results to returns that match the given view/status state.
Returns a JSON payload containing a collection of return objects for the requested page, along with any paging metadata provided by the API.
\nIf the requested pageNumber is beyond the available data, the API may return an empty list of records.
Authorization is required. The request must include a valid Authorization header, and may return an authorization error (such as 401/403) if the credentials are missing or invalid.
This description is aligned with similar GetReturnData/getReturns requests in this workspace while remaining specific to this endpoint.
optional view status param for viewing the return.
\n","type":"text/plain"},"key":"viewStatus","value":"VIEWED"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"1"}],"variable":[]}},"response":[{"id":"10acd508-6b3f-4943-99cc-7fc5646407c4","name":"GetReturnData","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Authorization","value":"Basic sadfasdfasd","type":"text","disabled":true}],"url":{"raw":"{{URL}}/api/returns?pageNumber=1&pageSize=1","host":["{{URL}}"],"path":["api","returns"],"query":[{"key":"viewStatus","value":"VIEWED","description":"optional view status param for viewing the return.","disabled":true},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Link","value":"https://api-staging.sprintlogistics.com/api/returns?pageNumber=1&pageSize=1"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 08 Jan 2026 10:21:01 GMT"},{"key":"Content-Length","value":"812"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 1,\n \"Result\": [\n {\n \"CustomerReference\": null,\n \"RMANumber\": null,\n \"RmaStatus\": \"Complete\",\n \"Undeliverable\": false,\n \"Returns\": [\n {\n \"ReturnTracking\": \"6d5a44a0-a4ed-4348-a3b1-4444c442aa08\",\n \"ArrivalDate\": \"2024-05-15\",\n \"Status\": \"Complete\",\n \"Notes\": null,\n \"LinesEnclosed\": \"0\",\n \"CourierName\": null,\n \"ViewStatus\": \"NotViewed\",\n \"ConsigneDetails\": {\n \"CneeName\": null,\n \"CneeAddr1\": null,\n \"CneeAddr2\": null,\n \"CneeAddr3\": null,\n \"CneeState\": null,\n \"CneeCountry\": null,\n \"CneeEmail\": null,\n \"CneeTelephone\": null\n },\n \"StockOrderItems\": [\n {\n \"ReturnGoodsInProductId\": \"646c9df2-aaa2-4b83-97eb-d260a4993928\",\n \"SKU\": \"New iPhone Case \",\n \"TotalQuantity\": \"0\",\n \"ActualReceived\": \"1\",\n \"ExpiryDate\": null,\n \"Batch\": null,\n \"Grade\": \"RETURNS\",\n \"Action\": \"Return to Stock (Different SKU)\",\n \"SerialNumbers\": null,\n \"ProductStatus\": \"Complete\",\n \"ProductNotes\": null\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"0c901a79-0aed-45a1-9d61-ad7059c62d56"},{"name":"ViewReturn","id":"b93ad4a7-bac1-4d29-8a61-b335da8d4185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Overview
Marks a return as viewed in the Sprint logistics returns workflow.
EndpointGET /api/returns/setviewed?returnTracking=
Query Parameters
\nreturnTracking (string, required)
Authentication
\nUses HTTP Basic Authentication.
\nEnsure valid Basic credentials are configured (for example via the Authorization header or inherited auth settings in this collection).
Behavior & Side‑Effects
\nLocates the return record by the provided returnTracking value.
Updates the record’s state to indicate the return has been viewed (e.g., for internal tracking / UI badges).
\nIdempotent for the same returnTracking in most implementations (calling it again for an already-viewed return should not create duplicates, though the exact behavior depends on the backend).
Expected Responses
\n200 OK
Return was found and successfully marked as viewed.
\nResponse body typically contains details of the return and/or the updated status.
\n400 Bad Request
returnTracking query parameter.401 Unauthorized
404 Not Found
returnTracking.5xx Server Error
Usage Notes
\nCall this endpoint after a return has been opened/viewed in your application UI.
\nCombine with other Sprint returns endpoints to build a complete returns tracking workflow.
\noptional view status param for viewing the return.
\n","type":"text/plain"},"key":"viewStatus","value":""},{"disabled":true,"key":"returnTracking ","value":""}],"variable":[]}},"response":[],"_postman_id":"b93ad4a7-bac1-4d29-8a61-b335da8d4185"}],"id":"ae36a04c-98fa-466e-a329-3c9fb5d07359","_postman_id":"ae36a04c-98fa-466e-a329-3c9fb5d07359","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Retrieves a list of customer records from the data sync service.
\nEndpoint
\nMethod: GET
URL: /api/datasync/customers
Base URL Source: {{URL}} is provided by the active environment (for example, the Staging environment).
Authentication
\nThis request typically runs against an authenticated environment. Ensure any required auth (e.g., API key, session, or basic auth) is configured at the collection or environment level.
\nNo explicit auth headers are defined on this request; inherited auth may apply.
\nQuery Capabilities
\n?page=1&size=50), add those as query params when sending the request, based on your API’s specification.Response
\nReturns a list/array of customers from the data sync store.
\nEach customer object typically includes identifying information (such as ID, name, and contact details) and any sync-related metadata your API exposes.
\nUsage Notes
\nUse this endpoint to verify that customer data is being synchronized correctly in the target environment.
\nEnsure the URL environment variable points to the correct server (e.g., staging vs. production) before running.
This request has no body; all selection/filtering must be done through URL and query parameters (if supported by the backend).
\nRetrieves the list of all brands from the Sprint API.
\nWhat this endpoint does
\nSends a GET request to api/brands.
Returns the collection of brand records exposed by the Sprint backend.
\nAuthentication
\nRequires HTTP Basic authentication.
\nThe Authorization header must be set with a valid Basic auth token (e.g., using BOLT_TEST_USER_KEY / BOLT_TEST_PASSWORD from the active environment).
URL variable usage
\n{{URL}} is an environment/collection variable that holds the base URL for the API (for example, the staging or production host).
Ensure URL is defined in the active environment (such as Staging) and includes the trailing slash or path segment expected by your API configuration.
Use this request to verify connectivity and to fetch the current catalog of brands for your Sprint services.
\n","urlObject":{"path":["brands"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[{"id":"13e473da-8169-4113-a531-998995c9e631","name":"BrandsList","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic adsfasfasdfasd","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":"{{URL}}api/brands"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Link","value":"https://api-staging.sprintlogistics.com/api/brands"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 06 Jan 2026 10:43:10 GMT"},{"key":"Content-Length","value":"253"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 4,\n \"Result\": [\n {\n \"ID\": 6,\n \"BrandName\": \"ZEBRA\",\n \"IsActive\": \"true\"\n },\n {\n \"ID\": 28,\n \"BrandName\": \"Eaty Grassroot\",\n \"IsActive\": \"true\"\n },\n {\n \"ID\": 27,\n \"BrandName\": \"COGNEX\",\n \"IsActive\": \"true\"\n },\n {\n \"ID\": 42,\n \"BrandName\": \"1\",\n \"IsActive\": \"true\"\n }\n ]\n}"}],"_postman_id":"015d55a5-f1fa-4b0c-a24d-cdc8adec6c02"}],"id":"d34ad90a-38bb-4fb4-877e-b85b4442793c","_postman_id":"d34ad90a-38bb-4fb4-877e-b85b4442793c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Retrieves a paginated list of Goods Received Notes (GRNs) from the Sprint API.
\nGET{{URL}}/api/grns/grns_listUse this endpoint to fetch GRNs that have been recorded in the system. It is typically used by dashboards or backend services that need to display or process received goods data.
\nThis request runs against the environment configured for Sprint APIs. The active environment exposes these variables:
\nURL – base URL for the API.BOLT_TEST_USER_KEY / BOLT_TEST_PASSWORD – credentials required for authenticated requests.Ensure you are using the correct environment (e.g., Staging) and that the required auth is configured in the Authorization tab.
\nA successful 200 OK response returns a JSON array of Data objects. Each object represents a single GRN record.
Data ObjectRetrieves Proof of Delivery (POD) / final‑mile tracking information for a shipment using a customer reference.
\nGET/api/shipment/GetPODTrackingAuthorization headercustomerReference (string, required)Example full request URL:
\nGET /api/shipment/GetPODTracking?customerReference=order_number\napplication/json200 OK – POD / final‑mile tracking details successfully retrieved4xx – Client errors (e.g., invalid or missing customerReference, auth issues)5xx – Server errorsA successful 200 OK response returns a JSON object with the following structure.
Tracking ObjectPOD ObjectTrackingEvent Object{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 1,\n \"Tracking\": {\n \"Carrier\": \"SAMPLE-CARRIER\",\n \"TrackingURL\": null,\n \"POD\": {\n \"PodName\": \"J. Doe\",\n \"DeliveryDate\": \"15-Jan-24\",\n \"DeliveryTime\": \"10:30\"\n },\n \"Tracking\": [\n {\n \"TrackedOn\": \"2024-01-15 10:30:00\",\n \"Location\": \"POD_TRACKING\",\n \"TrackedID\": \"SAMPLE-TRACK-0000001\",\n \"Description\": \"Delivered\",\n \"ServiceLevel\": \"010 UK-48\"\n }\n ]\n }\n}\nRefer to the saved example(s) on this request for a concrete sample response body and structure.
\n","urlObject":{"path":["api","shipment","GetPODTracking"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"6be236dd-1bb7-4a92-bc0b-b0d7349b4abd","name":"Tracking Final Mile","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Authorization","value":"Basic asdfasdfasdf","type":"text","disabled":true}],"url":{"raw":"{{URL}}/api/shipment/GetPODTracking","host":["{{URL}}"],"path":["api","shipment","GetPODTracking"],"query":[{"key":"customerReference","value":"370986","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"Status\": true,\n \"Message\": \"Success\",\n \"Count\": 2,\n \"Tracking\": {\n \"Carrier\": \"HERMES\",\n \"TrackingURL\": null,\n \"POD\": {\n \"PodName\": \"maseey\",\n \"DeliveryDate\": \"08-Jun-23\",\n \"DeliveryTime\": \"14:58\"\n },\n \"Tracking\": [\n {\n \"TrackedOn\": \"2023-06-08 14:58:00\",\n \"Location\": \"POD_TRACKING\",\n \"TrackedID\": \"H01EDA0004486618\",\n \"Description\": \"Delivered\",\n \"ServiceLevel\": \"010 UK-48\"\n },\n {\n \"TrackedOn\": \"2023-06-08 14:58:00\",\n \"Location\": \"POD_TRACKING\",\n \"TrackedID\": \"H01EDA0004486618\",\n \"Description\": \"Shipment delivered\",\n \"ServiceLevel\": \"010 UK-48\"\n },\n {\n \"TrackedOn\": \"2023-06-08 09:23:00\",\n \"Location\": \"POD_TRACKING\",\n \"TrackedID\": \"H01EDA0004486618\",\n \"Description\": \"Courier Received\",\n \"ServiceLevel\": \"010 UK-48\"\n },\n {\n \"TrackedOn\": \"2023-06-08 11:19:00\",\n \"Location\": \"POD_TRACKING\",\n \"TrackedID\": \"H01EDA0004486618\",\n \"Description\": \"Delivery 14:00 - 16:00 today\",\n \"ServiceLevel\": \"010 UK-48\"\n }\n ]\n }\n}"}],"_postman_id":"457676d5-8af0-4dad-845b-0aba15c27959"},{"name":"TrackingWithReturn","id":"4ac778d5-5a30-46ca-ab41-f57a46898714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/shipment/trackingwithreturn","description":"Retrieves tracking details for a shipment from the Sprint Logistics API, including both the outbound shipment and any associated return shipment information.
\nThis endpoint is typically used by customer service, operations, or integrated systems to look up the current status and history of a parcel using its HAWB (House Air Waybill) or consignment number.
\nGET /api/shipment/trackingwithreturn?hawb={hawb}
Method: GET
Base URL: {{URL}} (provided by the active environment, for example the Staging or Production base URL)
Path: /api/shipment/trackingwithreturn
If the specified hawb exists, the API returns the latest tracking status along with any linked return shipment information. If it does not exist or is invalid, the API may return an empty result set or an error, depending on server-side validation.
This endpoint requires Basic Authentication.
\nAuthorization: Basic
\nIn Postman, the credentials are typically sourced from environment variables (for example, username and password specific to Staging or Production).
\nEnsure that:
\nThe request uses Basic Auth (or an equivalent pre-computed Authorization header).
The credentials correspond to a valid Sprint Logistics API user with permission to view shipment tracking data.
\nThe following headers are expected by the API:
\nAccept: application/json\nContent-Type: application/json\nAuthorization: Basic <base64-encoded-credentials>\n\nAccept: application/json – Requests a JSON response.
Content-Type: application/json – Indicates JSON is used (even though this is a GET request with no body).
Authorization – Basic auth token as described above.
12766107Request
\nGET /api/shipment/trackingwithreturn?hawb=12766107\nAccept: application/json\nContent-Type: application/json\nAuthorization: Basic <base64-encoded-credentials>\n\n7427342Request
\nGET /api/shipment/trackingwithreturn?hawb=7427342\nAccept: application/json\nContent-Type: application/json\nAuthorization: Basic <base64-encoded-credentials>\n\nIn both examples:
\nReplace {{URL}} with the correct base URL from your selected environment (e.g. Staging or Production).
Ensure valid Basic Auth credentials are configured in the request or inherited from the parent folder/collection.
\nThis request shares behavior and configuration patterns with other TrackingWithReturn requests in this workspace (for example, those used for different environments or test scenarios). You can refer to them for additional examples of valid headers, query parameters, and auth configuration if needed.
Retrieves shipment tracking details by HAWB (House Air Waybill) / air waybill.
\nMethod: GET
URL: /api/shipment/tracking
{{URL}} environment variable.HAWB (required): The shipment’s HAWB / air waybill number used to look up tracking information.
7409285, 1213093430, 4578459.Type: Basic Auth
\nHow it’s set: Credentials are already configured via the Authorization header using a Basic token.
This request uses the HAWB query parameter and Basic Auth to return the current tracking status and related details for the specified shipment.
This POST endpoint {{URL}}/api/shipment/GenerateShippingLabel/ creates a shipping label for a forward shipment using provided pickup/drop addresses, order details, shipment dimensions, and courier/warehouse routing information. The payload is sent as JSON and authenticated using a Basic Authorization header.
Authentication & headers
\nUses HTTP Basic auth via the Authorization header (e.g., Authorization: Basic ).
Content-Type: application/json is required.
Key behaviors / notes
\nGenerates a shipping label for a single order (forward shipment flow).
\nRequires complete pickup and drop address information, including contact details.
\nExpects line-level order items with pricing and quantities to compute order amount.
\nShipment dimensions (L×B×H×weight) are required and typically in courier-agreed units (e.g., cm and grams/kg).
\ncourierId and warehouseCode are used to route the shipment through the correct provider and warehouse.
The body structure and sample values below are derived from similar Postman requests named \"Shipment Label increff\" in this and related workspaces (UIDs: 25659992-a48e2290-34d4-48cb-bf5c-2993c02e623b, 25659992-731cf58d-3ccc-4879-a526-3ec45e860039, 25659992-13a614f8-83cf-49e7-a715-1732c6227662).
Request body (JSON) – structure overview
\n{\n \"pickupAddress\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"middleName\": \"\",\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\"\n },\n \"dropAddress\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"middleName\": \"\",\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\"\n },\n \"orderDetails\": {\n \"orderNumber\": \"string\",\n \"paymentType\": \"string\",\n \"orderAmount\": int,\n \"orderDate\": \"string\",\n \"shipmentType\": \"string\",\n \"shipmentCode\": \"string\",\n \"orderLineItems\": [\n {\n \"name\": \"string\",\n \"sku\": \"string\",\n \"sellingPricePerUnit\": int,\n \"quantity\": int\n },\n {\n \"name\": \"string\",\n \"sku\": \"string\",\n \"sellingPricePerUnit\": int,\n \"quantity\": int\n }\n ]\n },\n \"shipmentDimension\": {\n \"length\": int,\n \"breadth\": int,\n \"height\": int,\n \"weight\": int\n },\n \"courierId\": int,\n \"warehouseCode\": \"string\"\n}\n\nField-level notes (main sections)
\npickupAddress: Sender/shipper address and contact details from where the parcel will be picked up.
dropAddress: Consignee/customer address and contact details where the parcel will be delivered.
orderDetails: Commercial details of the order, including order number, payment type, total amount, order date, shipment direction (FORWARD), service/shipment code, and an array of orderLineItems with item name, SKU, unit price, and quantity.
shipmentDimension: Physical dimensions and weight of the shipment used to calculate volumetric/chargeable weight.
courierId: Numeric identifier of the courier partner/service through which the label will be generated.
warehouseCode: Internal warehouse/location code from which the shipment will be fulfilled.
Creates or registers a shipment tracking record.
\nThis endpoint is used to create a tracking entry for a shipment, including its current status, carrier, tracking URL, and one or more shipping label records.
\nMethod: POST
URL: /api/shipment/tracking/
This endpoint requires HTTP Basic Authentication via the Authorization header.
Example header (Base64-encoded username:password):
Authorization: Basic M0Y5M0FEODgtQzEzRi00MjBELUIyMzAtQjREOEMxQzJFQkNGOjI3RTM3MkE3LTlEQUYtNDFGNi1CM0I1LTI3QjcwODc1QkE1Ng==\n\nReplace the encoded value with valid credentials for your environment.
\nContent-Type: application/json
Authorization: Basic
Send a JSON object with the following fields:
\nHAWB (integer, required) – House Air Waybill or shipment reference number for the consignment.
TrackingID (string, required) – Primary tracking identifier for the shipment.
Carrier (string, required) – Name or code of the carrier handling the shipment (for example, DHL, UPS, or an internal test value).
ParcelStatus (string, required) – Current status of the shipment (for example, ReadyToShip, InTransit, Delivered, etc., depending on your implementation).
TrackingURL (string, URL, optional/required as per your system rules) – Public URL where the shipment can be tracked.
IsReturn (boolean, required) – Indicates whether this shipment is a return shipment (true) or an outbound shipment (false).
ShippingLabels (array of objects, required) – List of shipping label records associated with the shipment. Each object includes:
TrackingID (string, required) – Tracking ID for this specific label/parcel.
DeliveryStatus (string, required) – Current delivery status for this label (for example, ReadyToShip).
Weight (number, required) – Weight of the parcel (units as defined by your system, e.g., grams).
Length (number, required) – Length of the parcel.
Width (number, required) – Width of the parcel.
Height (number, required) – Height of the parcel.
SynchronizeShippingLabels (boolean, required) – When true, instructs the system to synchronize the shipping labels provided with the shipment’s existing labels.
{\n \"HAWB\": int,\n \"TrackingID\": \"string\",\n \"Carrier\": \"string\",\n \"ParcelStatus\": \"string\",\n \"TrackingURL\": \"string\",\n \"IsReturn\": bool,\n \"ShippingLabels\": [\n {\n \"TrackingID\": \"string\",\n \"DeliveryStatus\": \"string\",\n \"Weight\": int,\n \"Length\": int,\n \"Width\": int,\n \"Height\": int\n }\n ],\n \"SynchronizeShippingLabels\": bool\n}\n\nUpdates the shipment status to Shipped for a given HAWB (House Air Waybill) number.
\nMethod & URL
\nPUT /api/shipment/SetShipped?HAWB={hawb}Authentication
\nUses HTTP Basic Auth via the Authorization header.
Ensure valid Sprint API credentials are configured in your environment.
\nQuery Parameters
\nHAWB (string, required): Unique shipment/consignment identifier to mark as shipped.Behavior & Usage Notes
\nCall this after the shipment has been packed and is ready to be marked as shipped in Sprint.
\nThe request body is not used by this endpoint (leave it empty).
\nTypically used in workflow together with tracking-related endpoints such as ReceiveTracking and packing status operations (e.g., Status SetPacked).
If the HAWB does not exist or is invalid, the API returns an error response indicating the status could not be updated.
\nMethod: PUT
URL: /api/shipment/SetShipped?HAWB=6409317
Marks a shipment as shipped in the Sprint Logistics system using its HAWB (House Air Waybill) number.
\nType: Basic Auth
\nHeader: Authorization: Basic
This request currently sends Authorization: Basic asdfasdfas.
In practice you should provide valid base64‑encoded credentials for your Sprint API user.
\n{{URL}} – Base URL for the target environment.
{{URL}} = https://staging.your-sprint-api-host.comHAWB (query parameter, required)
Type: string
\nDescription: Unique shipment tracking/air waybill number used to identify the shipment to be marked as shipped.
\nExample: 6409317
Content-Type: application/json
Authorization: Basic
Body mode: raw
\nContent-Type: application/json
This endpoint, as configured here, does not send a JSON payload. If the API evolves to accept additional shipment data, include it as a JSON object in the raw body.
\nMark shipment 6409317 as shipped on Staging:
PUT {{URL}}/api/shipment/SetShipped?HAWB=6409317\nContent-Type: application/json\nAuthorization: Basic <base64-encoded-credentials>\n// no body required\n\nExpected behavior: the API updates the shipment with the specified HAWB to a shipped status and returns a success response (for example, HTTP 200 OK or similar), potentially with the updated shipment status in the response body.