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

List listings

Request

Results from the listings endpoint are paginated and the subset of listings 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. updated_at value should not be older than 3 months.

Example: updated_at=2023-01-01T17:27:46
channelstringrequired

Filter listings by Inventory channel name.

Example: channel=rts_drop_ship
conditionstring

Filter listings by condition code.

Enum"N""A""B""R"
pageinteger(int32)

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

Default 1
per_pageinteger(int32)<= 100

This allows control over the amount of results returned per page.

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/listings?updated_at=2023-01-01T17%3A27%3A46&channel=rts_drop_ship&condition=N&page=1&per_page=20' \
  -H 'api-version: 6'

Responses

A list of listings of units and lots. The total number of records in the set will be in the response header record_count.

Bodyapplication/json
listingsArray of objects(listing)
Response
application/json
{ "listings": [ { … } ] }

Show listings by identifier

Request

Returns the listing details for the listing that matches the identifier that is included in the query parameters.

Path
idstringrequired

The SKU or client identifier for the desired listing.

Example: S11727
Query
conditionstringrequired

Condition code.

Enum"N""A""B""R"
channelstring

Inventory channel name. Gives out the particular listing if there are multiple sku-channel combinations.

Example: channel=rts_drop_ship
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/listings/S11727?condition=N&channel=rts_drop_ship' \
  -H 'api-version: 6'

Responses

Returns the listing details for the listing that matches the identifier that is included in the query parameters.

Bodyapplication/json
listingobject(listing)

Listing attributes

Response
application/json
{ "listing": { "identifier": "S11727", "condition": "N", "channel": "rts_drop_ship", "quantity": 1, "lot": { … }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }

Update Listing quantity

Request

Tell the drop ship service that the client system does not want some amount of this inventory anymore available on this channel.

Path
idstringrequired

The SKU or client identifier for the desired listing.

Example: S11727
Headers
api-versionstringrequired

The version of the API to use.

Example: 6
Bodyapplication/jsonrequired
conditionstring

Condition code.

Enum"N""A""B""R"
channelstring

Inventory channel name

Example: "rts_drop_ship"
quantityinteger

Quantity of units or lots available. This will always be 1 for lots

Example: 1
curl -i -X PUT \
  https://developer.optoro.com/_mock/openapi/drop_ship/openapi/listings/S11727 \
  -H 'Content-Type: application/json' \
  -H 'api-version: 6' \
  -d '{
    "condition": "N",
    "channel": "rts_drop_ship",
    "quantity": 1
  }'

Responses

Returns the listing details for the listing that matches the identifier that is included in the query parameters.

Bodyapplication/json
messagestring
Example: "Listing quantity updated"
Response
application/json
{ "message": "Listing quantity updated" }

Orders

Operations

Shipments

Operations