Skip to content

Drop Ship (6.0)

The Drop Shipping API enables customers to fulfill orders for available units and lots that are in stock in the Optoro RMS.

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.optoro.com/_mock/openapi/drop_ship/openapi
Production
https://drop-ship.optiturn.com
Sandbox
https://drop-ship.sandbox.optiturn.com

Listings

Operations

Orders

Operations

Shipments

Operations

Lists shipments

Request

Results from the shipments endpoint are paginated and the subset of shipments that are returned are based on the page and per_page parameters supplied in the request. The total count of records in the set is returned in the response header record_count. This can be used to calculate the number of pages that need to be retrieved to get all records.

Query
updated_atstring(date-time)required

Last updated time in ISO 8601 format, UTC.

Example: updated_at=2022-01-01T17:27:46
channelstring

Filter shipments by Inventory channel name.

Example: channel=rts_drop_ship
pageinteger

The page of results to retrieve. If page number is above maximum an empty result set will be returned.

Default 1
per_pageinteger<= 100

This allows control over the amount of results returned per page. Maximum allowed value is 100.

Default 20
Headers
api-versionstringrequired

The version of the API to use.

Example: 6
curl -i -X GET \
  'https://developer.optoro.com/_mock/openapi/drop_ship/openapi/shipments?updated_at=2022-01-01T17%3A27%3A46&channel=rts_drop_ship&page=1&per_page=20' \
  -H 'api-version: 6'

Responses

Returns the list of shipments matching the given conditions.

Headers
record_countinteger

The total number of records in the set.

Bodyapplication/json
shipmentsArray of objects(shipment)
Response
application/json
{ "shipments": [ { … } ] }

Show details of a shipment

Request

Get details of a shipment by tracking number.

Path
idstringrequired

Tracking number of the package.

Example: 1Z2E07A20302245707
Query
carrierstring

Carrier used in shipping.

Example: carrier=UPS
Headers
api-versionstringrequired

The version of the API to use.

Example: 6
curl -i -X GET \
  'https://developer.optoro.com/_mock/openapi/drop_ship/openapi/shipments/1Z2E07A20302245707?carrier=UPS' \
  -H 'api-version: 6'

Responses

Returns the details of a shipment.

Bodyapplication/json
shipmentsArray of objects(shipment)
Response
application/json
{ "shipments": [ { … } ] }

Show list of the shipments for an order

Request

Get details of a shipments filtered by an order.

Path
idstringrequired

Client Order Identifier

Example: ORDER-1
Headers
api-versionstringrequired

The version of the API to use.

Example: 6
curl -i -X GET \
  https://developer.optoro.com/_mock/openapi/drop_ship/openapi/shipments/identifier/ORDER-1 \
  -H 'api-version: 6'

Responses

Returns the list of shipments for the given order.

Bodyapplication/json
shipmentsArray of objects(shipment)
Response
application/json
{ "shipments": [ { … } ] }