The Ordoro REST API provides programmatic access to orders, products, inventory, shipments, purchase orders, suppliers, warehouses, and dropshipping workflows. It uses Basic HTTP Authentication with API keys and communicates via JSON. All endpoints are available at the base URL https://api.ordoro.com/ with a rate limit of 500 requests per minute.
openapi: 3.0.0
info:
title: Ordoro API Documentation
description: "# Introduction\n\nThe Ordoro API can be used to access data or integrate to add functionality to Ordoro. The\
\ Ordoro API uses the application/json Content-Type. The Ordoro API documentation is in beta. [See our forum](https://forums.ordoro.com)\
\ for questions or comments to help us improve the docs or request features.\n#### Note: Any routes with a /v3 designation\
\ will not allow for trailing slashes while all other routes and endpoints will require a trailing slash.\n\n# Authentication\n\
\nThe Ordoro API uses [Basic HTTP Authentication](http://en.wikipedia.org/wiki/Basic_access_authentication). Please create\
\ API keys via Settings->Account Settings->API Keys in app and use those for basic auth in your API requests.\n\n# Additional\
\ Resources\n\nFor a look at some code examples on how to use the API check out our github repo https://github.com/ordoro/api-examples.\n\
\n# API Responses\n\nMost of our endpoints return either a list of objects or a single object instance. They share similar\
\ response shapes.\n\n## List endpoints\n\nList endpoints respond with the following parameters:\n\n| Name |\
\ Type | Description |\n|----------------|--------------------------|-------------|\n| `count` \
\ | int | The total number of objects returned by a query ( **not** necessarily the number of\
\ objects included in a response). |\n| `limit` | int | The maximum number of objects returned\
\ per request. Defaults to 10. Maximum is 100. You can set this as a URL parameter. |\n| `offset` | int \
\ | The number of objects being offset in the response. May be altered as a URL Parameter. |\n| `<model name>`\
\ | array | An array of objects. The name of the model should be singular. For example, the /v3/order endpoint will have\
\ an `order` parameter, as opposed to `orders`.|\n\nHere is an example response for the `/v3/order` list endpoint.\n\n\
```\n{\n \"count\": 2,\n \"limit\": 10,\n \"offset\" 0,\n \"order\": [\n {\n // an order\
\ object\n },\n {\n // another order object\n }\n ]\n}\n```\n\n## Instance endpoints\n\
\nInstance endpoints return a single instance of a serialized model. `/v3/order/{order_number}` is an example of an instance\
\ endpoint.\n\n# Error Handling\n\nError responses contain the following parameters:\n\n| Name | Type \
\ | Description |\n|-----------------|------------------|----------------------------------------------------------------------|\n\
| `error_message` | string | Some human-readable error message. |\n| `param`\
\ | string or `null` | The name of the corresponding parameter, or null for general errors. |\n\n# Rate Limiting\n\
\nAPI requests will be limited to 500 requests per minute. Any requests over this threshold will respond with a 429 status\
\ code."
contact: {}
version: '1.0'
servers:
- url: https://api.ordoro.com/
variables: {}
paths:
/address/:
get:
tags:
- Address
summary: List Addresses
description: ''
operationId: Address_GET
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/address_list'
deprecated: false
post:
tags:
- Address
summary: Create a new Address
description: ''
operationId: Address_POST
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/address'
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/address'
deprecated: false
/address/{address_id}/:
get:
tags:
- Address
summary: Get an Address by ID
description: ''
operationId: AddressByAddressId_GET
parameters:
- name: address_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/address'
deprecated: false
put:
tags:
- Address
summary: Update an Address by ID
description: ''
operationId: AddressByAddressId_PUT
parameters:
- name: address_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/address'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/update_address'
deprecated: false
/api_key/:
get:
tags:
- Api Key
summary: List API Keys
description: ''
operationId: ApiKey_GET
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/api_key_list'
deprecated: false
post:
tags:
- Api Key
summary: Create an API key
description: ''
operationId: ApiKey_POST
parameters: []
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/api_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_key'
deprecated: false
/api_key/{api_key_id}/:
delete:
tags:
- Api Key
summary: Delete an API Key by ID
description: ''
operationId: ApiKeyByApiKeyId_DELETE
parameters:
- name: api_key_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
deprecated: false
get:
tags:
- Api Key
summary: Get an API Key by ID
description: ''
operationId: ApiKeyByApiKeyId_GET
parameters:
- name: api_key_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/api_key'
deprecated: false
put:
tags:
- Api Key
summary: Update an API Key by ID
description: ''
operationId: ApiKeyByApiKeyId_PUT
parameters:
- name: api_key_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/api_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/put_api_key'
deprecated: false
/authenticated/:
get:
tags:
- Authenticated
summary: Check Authentication Status
description: ''
operationId: Authenticated_GET
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
title: Authenticated Response Schema
type: object
properties:
success:
type: boolean
required:
- success
deprecated: false
/cart/:
get:
tags:
- Cart
summary: List carts
operationId: Cart_GET
parameters:
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/searchParam'
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: all
in: query
description: ''
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successfully retrieved list of carts
content:
application/json:
schema:
$ref: '#/components/schemas/cart_list'
post:
tags:
- Cart
summary: Create a new Cart
description: Each sales channel has unique requirements, so the schema will depend on the value of the `type` parameter.
operationId: Cart_POST
requestBody:
content:
application/json:
schema:
discriminator:
propertyName: type
mapping:
amazon: '#/components/schemas/post_cart_amazon'
amazon_ca: '#/components/schemas/post_cart_amazon'
amazon_uk: '#/components/schemas/post_cart_amazon'
bigcommerce: '#/components/schemas/post_cart_bigcommerce'
channeladvisor: '#/components/schemas/post_cart_channeladvisor'
custom_integration: '#/components/schemas/post_cart_base'
ebay: '#/components/schemas/post_cart_ebay'
ecwid: '#/components/schemas/post_cart_ecwid'
etsy: '#/components/schemas/post_cart_etsy'
magento: '#/components/schemas/post_cart_magento'
magento_v2: '#/components/schemas/post_cart_magento_v2'
miva: '#/components/schemas/post_cart_miva'
reverb: '#/components/schemas/post_cart_reverb'
shopify: '#/components/schemas/post_cart_shopify'
shopsite: '#/components/schemas/post_cart_shopsite'
sps_commerce: '#/components/schemas/post_cart_sps_commerce'
square: '#/components/schemas/post_cart_square'
squarespace: '#/components/schemas/post_cart_squarespace'
stripe: '#/components/schemas/post_cart_stripe'
threedcart: '#/components/schemas/post_cart_threedcart'
volusion_v1: '#/components/schemas/post_cart_volusion_v1'
walmart: '#/components/schemas/post_cart_walmart'
wayfair: '#/components/schemas/post_cart_wayfair'
woocommerce: '#/components/schemas/post_cart_woocommerce'
oneOf:
- $ref: '#/components/schemas/post_cart_amazon'
- $ref: '#/components/schemas/post_cart_bigcommerce'
- $ref: '#/components/schemas/post_cart_channeladvisor'
- $ref: '#/components/schemas/post_cart_base'
- $ref: '#/components/schemas/post_cart_ebay'
- $ref: '#/components/schemas/post_cart_ecwid'
- $ref: '#/components/schemas/post_cart_etsy'
- $ref: '#/components/schemas/post_cart_magento'
- $ref: '#/components/schemas/post_cart_magento_v2'
- $ref: '#/components/schemas/post_cart_miva'
- $ref: '#/components/schemas/post_cart_reverb'
- $ref: '#/components/schemas/post_cart_shopify'
- $ref: '#/components/schemas/post_cart_shopsite'
- $ref: '#/components/schemas/post_cart_sps_commerce'
- $ref: '#/components/schemas/post_cart_square'
- $ref: '#/components/schemas/post_cart_squarespace'
- $ref: '#/components/schemas/post_cart_stripe'
- $ref: '#/components/schemas/post_cart_threedcart'
- $ref: '#/components/schemas/post_cart_volusion_v1'
- $ref: '#/components/schemas/post_cart_walmart'
- $ref: '#/components/schemas/post_cart_wayfair'
- $ref: '#/components/schemas/post_cart_woocommerce'
responses:
'201':
description: Cart successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_cart_type'
/cart/{cart_id}/:
get:
tags:
- Cart
summary: Get an individual cart
operationId: CartByCartId_GET
parameters:
- name: cart_id
in: path
description: The ID of the cart to be retrieved
required: true
style: simple
schema:
type: integer
responses:
'200':
description: Cart successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_cart_type'
'404':
description: Could not find this cart
deprecated: false
put:
tags:
- Cart
summary: Update a cart
description: Each sales channel has unique requirements, so the schema will depend on the value of the existing cart's
`type` parameter.
operationId: CartByCartId_PUT
parameters:
- name: cart_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/put_cart_amazon'
- $ref: '#/components/schemas/put_cart_bigcommerce'
- $ref: '#/components/schemas/put_cart_channeladvisor'
- $ref: '#/components/schemas/put_cart_base'
- $ref: '#/components/schemas/put_cart_ebay'
- $ref: '#/components/schemas/put_cart_ecwid'
- $ref: '#/components/schemas/put_cart_etsy'
- $ref: '#/components/schemas/put_cart_magento'
- $ref: '#/components/schemas/put_cart_magento_v2'
- $ref: '#/components/schemas/put_cart_miva'
- $ref: '#/components/schemas/put_cart_reverb'
- $ref: '#/components/schemas/put_cart_shopify'
- $ref: '#/components/schemas/put_cart_shopsite'
- $ref: '#/components/schemas/put_cart_sps_commerce'
- $ref: '#/components/schemas/put_cart_square'
- $ref: '#/components/schemas/put_cart_squarespace'
- $ref: '#/components/schemas/put_cart_stripe'
- $ref: '#/components/schemas/put_cart_threedcart'
- $ref: '#/components/schemas/put_cart_volusion_v1'
- $ref: '#/components/schemas/put_cart_walmart'
- $ref: '#/components/schemas/put_cart_wayfair'
- $ref: '#/components/schemas/put_cart_woocommerce'
responses:
'200':
description: Cart successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_cart_type'
deprecated: false
/cart/{cart_id}/warehouse/:
get:
tags:
- Cart
summary: Get cart warehouses
operationId: CartWarehouseByCartId_GET
parameters:
- name: cart_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
deprecated: false
/cart/{cart_id}/autosync/:
get:
tags:
- Cart
summary: Get cart sync setting
operationId: CartAutosyncByCartId_GET
parameters:
- name: cart_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
deprecated: false
delete:
tags:
- Cart
summary: Delete cart sync setting
operationId: CartAutosyncByCartId_DELETE
parameters:
- name: cart_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
deprecated: false
/company/:
get:
tags:
- Company
summary: Get Your Company Info
description: ''
operationId: Company_GET
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company'
deprecated: false
put:
tags:
- Company
summary: Update Your Company
description: ''
operationId: Company_PUT
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/put_company'
deprecated: false
/company/logo/:
get:
tags:
- Company
summary: Get Company Logo
description: ''
operationId: CompanyLogo_GET
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company_logo'
deprecated: false
/company/logo/{name}/:
get:
tags:
- Company
summary: Get Company Logo by Name
description: ''
operationId: CompanyLogoByName_GET
parameters:
- name: name
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company_logo'
deprecated: false
put:
tags:
- Company
summary: Update Company Logo by Name
description: ''
operationId: CompanyLogoByName_PUT
parameters:
- name: name
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company_logo'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/put_company_logo'
deprecated: false
/company/{company_id}/logo/{name}/:
get:
tags:
- Company
summary: Get company logo by company ID and logo name
description: ''
operationId: CompanyLogoByCompanyIdAndName_GET
parameters:
- name: company_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: name
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company_logo'
deprecated: false
/company/{company_id}/logo/{name}/raw/:
get:
tags:
- Company
summary: Get raw logo image by company ID and logo name
description: The `name` parameter is the name of your company logo.
operationId: CompanyLogoRawByCompanyIdAndName_GET
parameters:
- name: company_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: name
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
deprecated: false
/goods_receipt/:
get:
tags:
- Goods Receipt
summary: Get a list of Goods Receipts
description: ''
operationId: GoodsReceipt_GET
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/searchParam'
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: status
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/status'
- name: start_date
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: end_date
in: query
description: ''
style: form
explode: true
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt_list'
deprecated: false
post:
tags:
- Goods Receipt
summary: Create a Goods Receipt
description: ''
operationId: GoodsReceipt_POST
parameters: []
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_goods_receipt'
deprecated: false
/goods_receipt/{goods_receipt_id}/:
delete:
tags:
- Goods Receipt
summary: Delete a Goods Receipt by ID
description: ''
operationId: GoodsReceiptByGoodsReceiptId_DELETE
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt'
deprecated: false
get:
tags:
- Goods Receipt
summary: Get a Goods Receipt by ID
description: ''
operationId: GoodsReceiptByGoodsReceiptId_GET
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt'
deprecated: false
put:
tags:
- Goods Receipt
summary: Update a Goods Receipt by ID
description: ''
operationId: GoodsReceiptByGoodsReceiptId_PUT
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/put_goods_receipt'
deprecated: false
/goods_receipt/{goods_receipt_id}/comment/:
post:
tags:
- Goods Receipt
summary: Create a Goods Receipt Comment by ID
description: ''
operationId: GoodsReceiptCommentByGoodsReceiptId_POST
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/comment'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_comment'
deprecated: false
get:
summary: Retrieve Comments
operationId: GoodsReceiptCommentByGoodsReceiptId_GET
description: ''
tags:
- Goods Receipt
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
responses:
'200':
description: OK
content:
application/json:
example:
limit: 10
offset: 0
count: 1
comment:
- user: [email protected]
date: '2026-03-05T21:10:26.911724+00:00'
text: This is a very important comment
schema:
$ref: '#/components/schemas/comment'
/goods_receipt/{goods_receipt_id}/line/{goods_receipt_item_id}/:
put:
tags:
- Goods Receipt
summary: Update a Goods Receipt Line by Goods Receipt ID and Line ID
description: ''
operationId: GoodsReceiptLineByGoodsReceiptId_PUT
parameters:
- $ref: '#/components/parameters/goodsReceiptIDPath'
- name: goods_receipt_item_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/goods_receipt'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/put_goods_receipt_item'
deprecated: false
/integration/:
get:
tags:
- Integration
summary: Get a list of integrations
description: 'Get list of integrations - current integrations include: QuickBooks Online, Stripe'
operationId: Integration_GET
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/searchParam'
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: vendor
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/vendor'
- name: type
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/type'
- name: all
in: query
description: allows inclusion of archived integrations
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successfully retrieved list of integration
content:
application/json:
schema:
$ref: '#/components/schemas/integration_list'
deprecated: false
post:
tags:
- Integration
summary: Create an integration
description: Each integration vendor has unique requirements, so the schema will depend on the value of the `vendor`
parameter.
operationId: Integration_POST
parameters: []
responses:
'201':
description: Integration successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_integration_type'
requestBody:
required: true
content:
application/json:
schema:
discriminator:
propertyName: vendor
mapping:
quickbooks: '#/components/schemas/post_integration_quickbooks'
stripe: '#/components/schemas/post_integration_stripe'
ondOf:
- $ref: '#/components/schemas/IntegrationQuickBooksNewRequest'
- $ref: '#/components/schemas/IntegrationStripeNewRequest'
deprecated: false
/integration/{integration_id}/:
get:
tags:
- Integration
summary: Get an integration by ID
description: ''
operationId: IntegrationByIntegrationId_GET
parameters:
- name: integration_id
in: path
description: the id of the integration to be retrieved
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_integration_type'
headers: {}
deprecated: false
put:
tags:
- Integration
summary: Update an integration
description: Each integration has unique requirements, so the schema will depend on the value of the existing integration's
`vendor` parameter.
operationId: IntegrationByIntegrationId_PUT
parameters:
- name: integration_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/one_of_integration_type'
headers: {}
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/put_integration_quickbooks'
- $ref: '#/components/schemas/put_integration_stripe'
deprecated: false
/label/{label_id}/raw/:
get:
tags:
- Label
summary: Get raw label data by ID
description: Get label data as stored from the carrier in its direct raw image form or converted from PDF
operationId: LabelRawByLabelId_GET
parameters:
- name: label_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers:
cache-control: private
pragma: public
deprecated: false
/packing_list/:
get:
tags:
- Packing List
summary: Get a list of packing lists
description: ''
operationId: PackingList_GET
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/searchParam'
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: packing_list_id
in: query
description: ''
style: form
explode: true
schema:
type: string
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/packing_list_list'
deprecated: false
post:
tags:
- Packing List
summary: Create a packing list
description: ''
operationId: PackingList_POST
parameters: []
responses:
'201':
description: ''
headers: {}
content:
application/json:
schema:
# --- truncated at 32 KB (613 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/openapi/ordoro-ordoro-api-openapi.yml