Ordoro Order API
Orders are the main level of management in Ordoro. Orders have lines, warehouse associations and can be dropshipped or have labels created for them.
OpenAPI Specification
openapi: 3.0.0
info:
title: Ordoro API Documentation Address Order API
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: {}
tags:
- name: Order
description: Orders are the main level of management in Ordoro. Orders have lines, warehouse associations and can be dropshipped or have labels created for them.
paths:
/v3/order/counts:
get:
summary: Get order status counts
operationId: OrderCounts_GET
tags:
- Order
responses:
'200':
description: OK
content:
application/json:
example:
awaiting_fulfillment: 3
cancelled: 0
dropshipment_requested: 0
shipped: 0
all: 3
schema:
$ref: '#/components/schemas/order_counts'
/v3/order/parent/{parent_order_number}:
get:
summary: Get parent order information
description: A parent order is left after an order is split, this information is view-only.
operationId: OrderParentByParentOrderNumber_POST
tags:
- Order
parameters:
- description: A parent order number
name: parent_order_number
type: string
in: path
required: true
responses:
'200':
description: 200 OK
content:
application/json:
schema:
$ref: '#/components/schemas/parent_order'
/v3/order:
get:
summary: Get a list of orders
operationId: Order_GET
tags:
- Order
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/searchParam'
- description: will return an order with a matching barcode regardless of other filters
name: barcode
schema:
type: string
in: query
required: false
- description: can be one of [all, awaiting_fulfillment, dropshipment_requested, shipped, cancelled]
name: status
in: query
required: false
schema:
type: string
enum:
- all
- awaiting_fulfillment
- shipped
- cancelled
- dropshipment_requested
- description: can be one of [could_not_allocate, unallocated, could_not_allocate, partial, allocated]
name: allocation_status
in: query
required: false
schema:
type: string
enum:
- could_not_allocate
- unallocated
- partial
- allocated
- overallocated
- name: allocatable
schema:
type: boolean
in: query
required: false
- name: sales_channel
schema:
type: array
items:
type: integer
in: query
required: false
- name: cart_order_id
schema:
type: string
in: query
required: false
- name: warehouse_id
schema:
type: array
items:
type: integer
in: query
required: false
- name: supplier
schema:
type: array
items:
type: integer
in: query
required: false
- name: shipper
schema:
type: array
items:
type: integer
in: query
required: false
- name: tag
schema:
type: array
items:
type: string
in: query
required: false
- description: filter the results to only orders that have no tags
name: untagged
schema:
type: string
in: query
required: false
- name: sku
schema:
type: array
items:
type: string
in: query
required: false
- description: including this parameter will filter the results to only orders that have labels that have been printed
name: printed
schema:
type: string
in: query
required: false
- name: has_similar_open_addresses
schema:
type: boolean
in: query
required: false
- name: similar_address_to
schema:
type: string
in: query
required: false
- name: ship_to_is_bill_to
schema:
type: boolean
in: query
required: false
- name: ship_to_country
schema:
type: array
items:
type: string
in: query
required: false
- description: can be one of [error, unvalidated, validated]
name: ship_to_status
schema:
type: string
enum:
- error
- unvalidated
- shipped
- cancelled
- validated
in: query
required: false
- name: created_after
schema:
type: string
in: query
required: false
- name: created_before
schema:
type: string
in: query
required: false
- name: created_interval_type
schema:
type: string
in: query
required: false
- name: created_interval_amount
schema:
type: number
in: query
required: false
- name: created_interval_trunc
schema:
type: boolean
in: query
required: false
- name: updated_after
schema:
type: string
in: query
required: false
- name: updated_before
schema:
type: string
in: query
required: false
- name: updated_interval_type
schema:
type: string
in: query
required: false
- name: updated_interval_amount
schema:
type: number
in: query
required: false
- name: updated_interval_trunc
schema:
type: boolean
in: query
required: false
- name: order_placed_after
schema:
type: string
in: query
required: false
- name: order_placed_before
schema:
type: string
in: query
required: false
- name: order_placed_interval_type
schema:
type: string
in: query
required: false
- name: order_placed_interval_amount
schema:
type: number
in: query
required: false
- name: order_placed_interval_trunc
schema:
type: boolean
in: query
required: false
- name: shipped_after
schema:
type: string
in: query
required: false
- name: shipped_before
schema:
type: string
in: query
required: false
- name: shipped_interval_type
schema:
type: string
in: query
required: false
- name: shipped_interval_amount
schema:
type: number
in: query
required: false
- name: shipped_interval_trunc
schema:
type: boolean
in: query
required: false
- name: dropshipped_after
schema:
type: string
in: query
required: false
- name: dropshipped_before
schema:
type: string
in: query
required: false
- name: dropshipped_interval_type
schema:
type: string
in: query
required: false
- name: dropshipped_interval_amount
schema:
type: number
in: query
required: false
- name: dropshipped_interval_trunc
schema:
type: boolean
in: query
required: false
- name: deliver_by_after
schema:
type: string
in: query
required: false
- name: deliver_by_before
schema:
type: string
in: query
required: false
- name: deliver_by_interval_type
schema:
type: string
in: query
required: false
- name: deliver_by_interval_amount
schema:
type: number
in: query
required: false
- name: deliver_by_interval_trunc
schema:
type: boolean
in: query
required: false
- name: ship_by_after
schema:
type: string
in: query
required: false
- name: ship_by_before
schema:
type: string
in: query
required: false
- name: ship_by_interval_type
schema:
type: string
in: query
required: false
- name: ship_by_interval_amount
schema:
type: number
in: query
required: false
- name: ship_by_interval_trunc
schema:
type: boolean
in: query
required: false
- name: cancelled_after
schema:
type: string
in: query
required: false
- name: cancelled_before
schema:
type: string
in: query
required: false
- name: cancelled_interval_type
schema:
type: string
in: query
required: false
- name: cancelled_interval_amount
schema:
type: number
in: query
required: false
- name: cancelled_interval_trunc
schema:
type: boolean
in: query
required: false
- name: timezone
schema:
type: string
in: query
required: false
- description: can be one of [(-)batch, (-)order_placed_date, (-)grand_total, (-)order_number, (-)created_date, (-)updated_date, (-)ship_date, (-)dropship_date, (-)deliver_by_date, (-)ship_by_date, (-)cancelled_date, (-)shipping_method, (-)status, (-)billing_address_name, (-)billing_address_zip, (-)shipping_address_name, (-)shipping_address_zip, (-)sku]
name: sort
in: query
required: false
schema:
type: string
enum:
- batch
- -batch
- order_placed_date
- -order_placed_date
- grand_total
- -grand_total
- order_number
- -order_number
- created_date
- -created_date
- updated_date
- -updated_date
- ship_date
- -ship_date
- dropship_date
- -dropship_date
- deliver_by_date
- -deliver_by_date
- ship_by_date
- -ship_by_date
- cancelled_date
- -cancelled_date
- shipping_method
- -shipping_method
- status
- -status
- billing_address_name
- -billing_address_name
- billing_address_zip
- -billing_address_zip
- shipping_address_name
- -shipping_address_name
- shipping_address_zip
- -shipping_address_zip
- sku
- -sku
- name: tag_filter_by
schema:
type: string
enum:
- or
- and
- only
- not
in: query
required: false
- name: exclude_tags
schema:
type: array
items:
type: string
in: query
required: false
- name: batch_reference_id
schema:
type: string
in: query
required: false
- name: has_revision
schema:
type: boolean
in: query
required: false
- name: in_batch
schema:
type: boolean
in: query
required: false
- name: carrier_error
schema:
type: boolean
in: query
required: false
- name: batch_error
schema:
type: boolean
in: query
required: false
responses:
'200':
description: OK
content:
application/json:
example:
updated_date: '2016-02-01T17:27:24.059091-06:00'
status: shipped
shippability: shippable
notes_from_customer: null
billing_address:
city: austin
state: TX
name: joe schmo
zip: '78701'
country: US
street1: 123 foo-bar ln
company: null
street2: null
phone: '4592222'
email: mrgattispizza@delivers.com
validation:
status: unvalidated
suggested: []
additional_text: null
financial:
grand_total: 123.45
tax_amount: 1.23
product_amount: 100.1
shipping_amount: 0
credit_card_issuer: vvisa
discount_amount: 0
requested_shipping_method: null
tags:
- color: '#ff0'
text: Unpaid
link: /tag/3
id: 3
- color: '#EE7AE9'
text: Phony
link: /tag/5
id: 5
shipping_info:
shipping_method: GROUND_HOME_DELIVERY
ship_date: '2016-01-06T06:06:06.123456-06:00'
created_date: '2016-01-06T16:01:00.284745-06:00'
tracking_number: '782113802577'
cost: 11.47
tracking_url: http://www.fedex.com/Tracking?action=track&language=english&last_action=alttrack&ascend_header=1&cntry_code=us&initial=x&mps=y&tracknumbers=782113802577
has_label: true
carrier_name: null
carrier:
id: 1234
link: /carrier/1234
box_shape: big
length: 7
width: 7
height: 7
weight: 3
shipping_address:
city: austin
state: TX
name: Leroy
zip: '78701'
country: US
street1: 101 W 6th St
company: null
street2: null
phone: '8675309'
email: jenny@igotyournumber.com
lines:
- quantity: 1
item_price: 1.23
link: /order/M-order-1234/line/1001
id: 1001
product_name: product 1
product_link: /product/sku1
sku: sku1
shippability: shippable
details: Size:Medium
- quantity: 1
item_price: 4.56
link: /order/M-order-1234/line/1002
id: 1002
product_name: product 2
product_link: /product/sku2
sku: sku2
shippability: shippable
details: Size:Medium
cart:
link: /cart/28
id: 28
dropshipping_info: {}
order_placed_date: '2015-12-09T06:01:00.855700-06:00'
return_shipping_info: {}
created_date: '2015-12-15T11:35:46.284745-06:00'
warehouse:
link: /warehouse/15450
id: 15450
order_number: M-order-1234
barcode: '148191668853950'
comments: []
link: /order/M-order-1234
schema:
$ref: '#/components/schemas/order_list'
post:
summary: Create an Order
operationId: Order_POST
tags:
- Order
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_order_v1'
examples:
example:
value:
order_id: i-want-my-order-1234
cart: 100
cart_order_id: this-is-from-the-cart-1234
order_date: '2015-12-09T12:01:00.855700'
shipping_address:
name: joe schmo
street1: 123 foo-bar ln
city: austin
state: tx
zip: '78701'
country: USA
phone: '8675309'
email: jenny@igotyournumber.com
billing_address:
name: joe schmo
street1: 123 foo-bar ln
city: austin
state: tx
zip: '78701'
country: USA
phone: '4592222'
email: mrgattispizza@delivers.com
lines:
- cart_orderitem_id: abc.123
quantity: 2
item_price: 2.42
total_price: 4.84
product:
sku: sku1
name: special product name
price: 2.42
weight: 1
taxable: 'false'
cost: 1.21
amazon_extra_info:
pending_quantity: 4
listing_id: '12356'
asin: '55555'
- cart_orderitem_id: abc.456
quantity: 1
item_price: 1.23
total_price: 1.23
product:
sku: sku2
name: Plastic Toy
price: 1.23
weight: 2
taxable: 'false'
cost: 3.45
tags:
- text: Unpaid
color: '#FFFFFF'
- text: Alert
color: '#C0C0C0'
product_amount: 100.1
tax_amount: 1.23
grand_total: 123.45
description: A legacy Order object
parameters: []
responses:
'201':
description: Order Successfully created
content:
application/json:
example:
updated_date: '2015-12-09T14:48:06.372425-06:00'
status: new
notes_from_customer: null
billing_address:
city: austin
state: TX
name: joe schmo
zip: '78701'
country: US
street1: 123 foo-bar ln
company: null
street2: null
phone: '4592222'
email: mrgattispizza@delivers.com
validation:
status: unvalidated
suggested: []
additional_text: null
financial:
grand_total: 123.45
tax_amount: 1.23
product_amount: 100.1
shipping_amount: 0
credit_card_issuer: null
discount_amount: 0
requested_shipping_method: null
tags:
- color: '#ff0'
text: Unpaid
link: /tag/3
id: 3
- link: /tag/2
color: '#FF0'
text: Alert
id: 2
shipping_info: {}
weight: 3
shipping_address:
city: austin
state: TX
name: joe schmo
zip: '78701'
country: US
street1: 123 foo-bar ln
company: null
street2: null
phone: '8675309'
email: jenny@igotyournumber.com
validation:
status: unvalidated
suggested: []
additional_text: null
lines:
- quantity: 1
item_price: 1.23
link: /order/M-order-1234/line/1001
product_name: product 1
product_link: /product/sku1
sku: sku1
shippability: shippable
details: Size:Medium
- quantity: 1
item_price: 4.56
link: /order/M-order-1234/line/1002
product_name: product 2
product_link: /product/sku2
sku: sku2
shippability: unshippable
details: Size:Medium
cart:
link: /cart/28
id: 28
dropshipping_info: {}
order_placed_date: '2015-12-09T06:01:00.855700-06:00'
return_shipping_info: {}
created_date: '2015-12-09T13:37:36.884178-06:00'
warehouse:
link: /warehouse/15450
id: 15450
order_number: M-order-1234
barcode: '148191668853950'
comments: []
link: /order/M-order-1234
schema:
$ref: '#/components/schemas/order'
/v3/order/{order_number}:
get:
summary: Retrieve an Order
operationId: OrderByOrderNumber_GET
description: Example Request `GET /order/M-order-1234`
tags:
- Order
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'200':
description: OK
content:
application/json:
example:
updated_date: '2016-02-01T17:27:24.059091-06:00'
status: shipped
notes_from_customer: null
billing_address:
city: austin
state: TX
name: joe schmo
zip: '78701'
country: US
street1: 123 foo-bar ln
company: null
street2: null
phone: '4592222'
email: mrgattispizza@delivers.com
validation:
status: unvalidated
suggested: []
additional_text: null
financial:
grand_total: 123.45
tax_amount: 1.23
product_amount: 100.1
shipping_amount: 0
credit_card_issuer: vvisa
discount_amount: 0
requested_shipping_method: null
tags:
- color: '#ff0'
text: Unpaid
link: /tag/3
id: 3
- color: '#EE7AE9'
text: Phony
link: /tag/5
id: 5
shipping_info:
shipping_method: GROUND_HOME_DELIVERY
ship_date: '2016-01-06T06:06:06.123456-06:00'
tracking_number: '782113802577'
cost: 11.47
tracking_url: http://www.fedex.com/Tracking?action=track&language=english&last_action=alttrack&ascend_header=1&cntry_code=us&initial=x&mps=y&tracknumbers=782113802577
has_label: true
carrier_name: null
carrier:
id: 1234
link: /carrier/1234
box_shape: big
length: 7
width: 7
height: 7
weight: 3
shipping_address:
city: austin
state: TX
name: Leroy
zip: '78701'
country: US
street1: 101 W 6th St
company: null
street2: null
phone: '8675309'
email: jenny@igotyournumber.com
validation:
status: unvalidated
suggested: []
additional_text: null
lines:
- quantity: 1
item_price: 1.23
link: /order/M-order-1234/line/1001
product_name: product 1
product_link: /product/sku1
sku: sku1
shippability: shippable
details: Size:Medium
- quantity: 1
item_price: 4.56
link: /order/M-order-1234/line/1002
product_name: product 2
product_link: /product/sku2
sku: sku2
shippability: unshippable
details: Size:Medium
cart:
link: /cart/28
id: 28
dropshipping_info: {}
order_placed_date: '2015-12-09T06:01:00.855700-06:00'
return_shipping_info: {}
created_date: '2015-12-15T11:35:46.284745-06:00'
warehouse:
link: /warehouse/15450
id: 15450
order_number: M-order-1234
barcode: '148191668853950'
comments: []
link: /order/M-order-1234
schema:
$ref: '#/components/schemas/order'
put:
summary: Update an Order's information
operationId: OrderByOrderNumber_PUT
tags:
- Order
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/put_order'
examples:
example:
value:
weight: 10.5
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'200':
description: 200 OK
content:
application/json:
example:
updated_date: '2016-02-01T17:27:24.059091-06:00'
status: shipped
notes_from_customer: null
billing_address:
city: austin
state: TX
name: joe schmo
zip: '78701'
country: US
street1: 123 foo-bar ln
company: null
street2: null
phone: '4592222'
email: mrgattispizza@delivers.com
validation:
status: unvalidated
suggested: []
additional_text: null
financial:
grand_total: 123.45
tax_amount: 1.23
product_amount: 100.1
shipping_amount: 0
credit_card_issuer: vvisa
discount_amount: 0
requested_shipping_method: null
tags:
- color: '#ff0'
text: Unpaid
link: /tag/3
id: 3
- color: '#EE7AE9'
text: Phony
link: /tag/5
id: 5
shipping_info:
shipping_method: GROUND_HOME_DELIVERY
ship_date: '2016-01-06T06:06:06.123456-06:00'
tracking_number: '782113802577'
cost: 11.47
tracking_url: http://www.fedex.com/Tracking?action=track&language=english&last_action=alttrack&ascend_header=1&cntry_code=us&initial=x&mps=y&tracknumbers=782113802577
has_label: true
carrier_name: null
carrier:
id: 1234
link: /carrier/1234
box_shape: big
length: 7
width: 7
height: 7
weight: 10.5
shipping_address:
city: austin
state: TX
name: Leroy
zip: '78701'
country: US
street1: 101 W 6th St
company: null
street2: null
phone: '8675309'
email: jenny@igotyournumber.com
validation:
status: unvalidated
suggested: []
additional_text: null
lines:
- quantity: 1
item_price: 1.23
link: /order/M-order-1234/line/1001
product_name: product 1
product_link: /product/sku1
sku: sku1
shippability: shippable
details: Size:Medium
- quantity: 1
item_price: 4.56
link: /order/M-order-1234/line/1002
product_name: product 2
product_link: /product/sku2
sku: sku2
shippability: unshippable
details: Size:Medium
cart:
link: /cart/28
id: 28
dropshipping_info: {}
order_placed_date: '2015-12-09T06:01:00.855700-06:00'
return_shipping_info: {}
# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/openapi/ordoro-order-api-openapi.yml