Importing Shipment Details

Git RepositoryEdit on Github
Last update: 2 years ago by luigi mangaReading time: 2 min

If your dropship provider is on a custom system, you may need to import shipping details from their system automatically. Onport allows you to do this via CSV (from an FTP or HTTP URI) or through a JSON feed.

The JSON feed location can be setup in the orders tab of the dropship provider. This should be a http:// or https:// location where the details can be fetched from. There is a 10 second max response time, so we recommend caching any data from the dropship provider if the shipment details cannot be fetched, parsed and returned within this duration.

The response should be in JSON, with a root shipments attribute in an array with the following details.

"shipments": [{
"vendorExternalId": "12345",
"trackingNumber": "tracking-number",
"trackingCompany": "tracking-company",
"reference": "148305-01"

Push Data Flow

In addition to regularly importing an array of shipments from CSV files or REST API endpoints, it is possible to push single dropshipments into Onport's API. This is ideal to implement near real-time dropshipments creation. When shipping details are saved by the vendor in their custom platform, Onport can receive an API call to create the dropshipment for the respective Purchase Order.

The following cURL request shows how to create a dropshipment for the Purchase Order :id.

curl --request POST \
--url \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{"inventoryStatus":"shipped","trackingNumber":"213123","serviceLevel":"555","trackingCompany":"GLS Germany","ids":[]}'
๐Ÿ’ป Vendor Integration โ€” Previous
Sending Orders
Next โ€” ๐Ÿ“‚ Exports
Api Data Exports