Ordoro Return Order Label API
The Return Order Label API from Ordoro — 8 operation(s) for return order label.
The Return Order Label API from Ordoro — 8 operation(s) for return order label.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ordoro-return-order-label-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Ordoro API Documentation Address Return Order Label 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: Return Order Label
paths:
/v3/return_order/label/australia_post:
post:
summary: Get Australia Post Label for Return Order
operationId: ReturnOrderLabelAustraliaPost_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_easypost_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"cost\": 13.23,\n \"ship_date\": \"2019-06-27T06:06:06.123456-06:00\",\n \"shipping_method\": \"TBD\",\n \"tracking_number\": \"555555555\",\n \"tracking_url\": \"http://www.auspost.com/Tracking?555555555\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/canada_post:
post:
summary: Get Canada Post Label for Return Order
operationId: ReturnOrderLabelCanadaPost_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_canada_post_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"cost\": 7.2,\n \"ship_date\": \"2016-02-17T06:06:06.123456-06:00\",\n \"shipping_method\": \"CANADA_AIR\",\n \"tracking_number\": \"782401895410\",\n \"tracking_url\": \"http://www.canada.com/Tracking?9873984\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/dhl:
post:
summary: Get DHL Label for Return Order
operationId: ReturnOrderLabelDHL_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_dhl_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"cost\": 13.23,\n \"ship_date\": \"2016-06-27T06:06:06.123456-06:00\",\n \"shipping_method\": \"P\",\n \"tracking_number\": \"555555555\",\n \"tracking_url\": \"http://www.dhl.com/Tracking?555555555\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/dhl_ecommerce:
post:
summary: Get DHL Label for Return Order
operationId: ReturnOrderLabelDHL_Ecommerce_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_dhl_ecommerce_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Return Label successfully created
examples:
application/json: "{\n \"cost\": 13.23,\n \"ship_date\": \"2016-06-27T06:06:06.123456-06:00\",\n \"shipping_method\": \"EXP\",\n \"tracking_number\": \"555555555\",\n \"tracking_url\": \"https://webtrack.dhlecs.com?tracking_number=555555555\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/endicia:
post:
summary: Get Endicia Label for Return Order
operationId: ReturnOrderLabelEndicia_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_endicia_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"cost\": 7.2,\n \"ship_date\": \"2016-02-17T06:06:06.123456-06:00\",\n \"shipping_method\": \"GROUND\",\n \"tracking_number\": \"782401895410\",\n \"tracking_url\": \"http://usps/tracking-number/34349384\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/fedex:
post:
summary: Get Fedex Label for Return Order
operationId: ReturnOrderLabelFedex_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_fedex_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"shipping_method\": \"FEDEX_GROUND\",\n \"ship_date\": \"2016-03-02T06:06:06.123456-06:00\",\n \"tracking_number\": \"782505088888\",\n \"cost\": 7.95,\n \"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=938475\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/pitney:
post:
summary: Get Pitney Label for Return Order
operationId: ReturnOrderLabelPitney_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_pitney_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"shipping_method\": \"PM\",\n \"ship_date\": \"2016-03-02T06:06:06.123456-06:00\",\n \"tracking_number\": \"782505088888\",\n \"cost\": 7.95,\n \"tracking_url\": \"http://www.pitney.com/track_it=782505088888\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
/v3/return_order/label/ups:
post:
summary: Get UPS Label for Return Order
operationId: ReturnOrderLabelUPS_POST
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/post_ups_label'
parameters:
- $ref: '#/components/parameters/orderNumberPath'
responses:
'201':
description: Label successfully created
examples:
application/json: "{\n \"cost\": 7.2,\n \"ship_date\": \"2016-02-17T06:06:06.123456-06:00\",\n \"shipping_method\": \"UPS_AIR\",\n \"tracking_number\": \"782401895410\",\n \"tracking_url\": \"http://www.ups.com/tracking-number?0987\"\n}\n"
headers:
Access-Control-Allow-Credentials:
type: string
Access-Control-Allow-Origin:
type: string
Vary:
type: string
schema:
$ref: '#/components/schemas/ShippingInfoResponse'
tags:
- Return Order Label
components:
schemas:
address:
title: Address Schema
type: object
additionalProperties: false
properties:
id:
type: integer
name:
example: Jimmy McGill
anyOf:
- type: string
- type: 'null'
company:
example: Hamlin, Hamlin & McGill
anyOf:
- type: string
- type: 'null'
street1:
example: 100 Constitution Ave
anyOf:
- type: string
- type: 'null'
street2:
anyOf:
- type: string
- type: 'null'
city:
example: Albuquerque
anyOf:
- type: string
- type: 'null'
state:
example: NM
anyOf:
- type: string
- type: 'null'
zip:
example: '87109'
anyOf:
- type: string
- type: 'null'
country:
example: US
anyOf:
- type: string
- type: 'null'
email:
example: slippin-jimmy@saul-good.man
anyOf:
- type: string
- type: 'null'
phone:
example: 555-867-5309
anyOf:
- type: string
- type: 'null'
fax:
anyOf:
- type: string
- type: 'null'
cart_address_id:
anyOf:
- type: string
- type: 'null'
revision_locked_fields:
type: array
validation:
title: Validation status of an Address
properties:
status:
type: string
enum:
- unvalidated
- validated
- warning
- error
suggested:
type: array
items:
title: Suggested Address
type: object
additionalProperties: false
properties:
is_commercial:
default: false
anyOf:
- type: boolean
- type: 'null'
street1:
type: string
street2:
anyOf:
- type: string
- type: 'null'
city:
type: string
state:
type: string
zip:
type: string
country_code:
anyOf:
- type: string
- type: 'null'
required:
- city
- state
- zip
- street1
additional_text:
anyOf:
- type: string
- type: 'null'
required:
- status
- additional_text
- suggested
additionalProperties: false
anyOf:
- type: object
- type: 'null'
required:
- name
- company
- street1
- street2
- city
- state
- zip
- country
- email
- phone
customs_line:
title: Customs Line Schema
type: object
additionalProperties: false
properties:
country:
type: string
description:
type: string
quantity:
type: integer
value:
description: Dollar value of customs line
format: double
type: number
weight:
description: Weight of customs line in ounces
type: number
harmonization_code:
description: The 6 character international nomenclature for the classification of products
type: string
sku:
type: string
unit_of_measure:
type: string
url:
type: string
harmonization_code_country:
description: The country of harmonization_code
type: string
required:
- description
- quantity
- value
- weight
- country
post_ups_label:
title: UPS Label Request Schema
type: object
additionalProperties: false
properties:
additional_handling:
type: boolean
certificate_origin:
default: false
type: boolean
customs_info:
items:
$ref: '#/components/schemas/customs_line'
type: array
delivery_confirmation:
description: '[''0'' - None, ''1'' - Confirm, ''2'' - Signature, ''3'' - Adult Signature, ''4'' - USPS for use with Mail Innovations]'
type: string
direct_delivery:
type: boolean
dry_ice_regulation_set:
description: indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
type: string
insurance_type:
type: string
insured_value:
default: 0
type: number
notify_bill_to:
default: false
type: boolean
notify_ship_to:
default: false
type: boolean
box_shape:
description: ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
type: string
declared_value:
description: Package level declared value for UPS
type: number
description:
description: Package level description, required for return shipments
type: string
dry_ice_weight:
description: Dry ice weight in ounces, required for dry ice shipments
type: number
height:
description: Height in inches
type: number
length:
description: Length in inches
type: number
weight:
description: weight of the package in ounces
type: number
width:
description: Width in inches
type: number
packages:
type: array
maxItems: 200
items:
additionalProperties: false
type: object
properties:
additional_handling:
type: boolean
box_shape:
description: ups box options [01 - UPS Letter, 02 - Customer Supplied Package, 03 - Tube, 04 - PAK, 2a - Small Express Box, 2b - Medium Express Box, 2c - Large Express Box, 24 - UPS 25KG Box, 25 - UPS 10KG Box]
type: string
declared_value:
description: Package level declared value for UPS
type: number
description:
description: Package level description, required for return shipments
type: string
dry_ice_regulation_set:
description: indicates dry ice shipment option [CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada, IATA = For Worldwide Air movement]
type: string
dry_ice_weight:
description: Dry ice weight in ounces, required for dry ice shipments
type: number
hazmat_items:
type: array
items:
$ref: '#/components/schemas/hazmat_item'
height:
description: Height in inches
type: number
length:
description: Length in inches
type: number
reference_number:
description: Package level reference, not always necessarily a number
type: string
weight:
description: weight of the package in ounces
type: number
width:
description: Width in inches
type: number
required:
- box_shape
package_bill_type:
description: 'required for shoptimeintransit rates: document, non-document, wwef pallet, or domestic pallet. describes the contents of the package.'
type: string
enum:
- '02'
- '03'
- '04'
- '07'
packing_list_id:
description: id for packing list for profile template associated with this label
type: integer
payment_type:
default: BillShipper
description: payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
type: string
payment_account:
description: account number for payment type
type: string
payment_zip:
description: 'postal code of the payor, required for payment_type: BillThirdParty'
type: string
payment_country:
description: '2 character country code of the payor, required for payment_type: BillThirdParty'
type: string
duties_payment_type:
default: BillShipper
description: payor for the shipment [BillShipper, BillReceiver, BillThirdParty]
type: string
duties_payment_account:
description: account number for payment type
type: string
duties_payment_zip:
description: 'postal code of the payor, required for payment_type: BillThirdParty'
type: string
duties_payment_country:
description: '2 character country code of the payor, required for payment_type: BillThirdParty'
type: string
purchase_order_number:
description: Customs level purchase order number reference
type: string
reason_for_export:
type: string
receiver_tax_info:
$ref: '#/components/schemas/tax_info'
recipient_address_is_residential:
type: boolean
reference_number:
description: Customer supplied internal reference for the order
type: string
return:
type: boolean
saturday_delivery:
default: false
type: boolean
sender_tax_info:
$ref: '#/components/schemas/tax_info'
shipper_id:
type: integer
shipper_type:
type: string
shipping_method:
description: 'options: [''01'' - Next Day, ''02'' - Second Day, ''03'' - Ground, ''07'' - Worldwide Express, ''08'' - Worldwide Expedited, ''11'' - Standard, ''12'' - Three Day Select, ''13'' - Next Day Air Saver, ''14'' - Next Day AM, ''54'' - Worldwide Express Plus, ''59'' - Second Day AM, ''65'' - Saver, ''92'' - SurePost Less Than 1 lb, ''93'' - SurePost Greater Than 1lb, ''94'' - SurePost BPM, ''95'' - SurePost Media; The following service types are used with UPS Mail Innovations: ''M2'' - USPS First Class Mail, ''M3'' - USPS Priority Mail, ''M4'' - Expedited Mail Innovations, ''M5'' - Priority Mail Innovations, ''M6'' - Economy Mail Innovations]'
type: string
shipper_release:
type: boolean
shipper_return_to_address:
$ref: '#/components/schemas/v1_address'
ship_from:
description: The ship_from address is used as the originating address of the rate and label request.
$ref: '#/components/schemas/v1_address'
ship_to:
description: The to address is used as the destination address of a return order rate and label request.
$ref: '#/components/schemas/v1_address'
reference_id:
description: Identifier for a Return Order
type: string
usps_endorsement:
description: Required for UPS Mail Innovations shipments
type: string
warehouse_id:
description: Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
type: integer
cost_center:
description: The Cost Center code for UPS Mail Innovations shipments
type: string
maxLength: 30
required:
- shipper_id
- shipping_method
post_dhl_ecommerce_label:
title: DHL eCommerce Label Request schema
type: object
additionalProperties: false
properties:
shipper_id:
type: integer
packages:
maxItems: 1
type: array
items:
type: object
additionalProperties: false
properties:
weight:
description: Weight in ounces
type: number
length:
description: Length in inches
type: number
width:
description: Width in inches
type: number
height:
description: Height in inches
type: number
declared_value:
type: number
description:
type: string
box_shape:
description: ignored
type: string
required:
- length
- width
- height
- weight
- description
packing_list_id:
description: id for packing list for profile template associated with this label
type: integer
dangerous_goods:
type: string
delivery_confirmation:
enum:
- DELCON
- SIGCON
type: string
service_endorsement:
description: 1 - Address Service Requested; 2 - Forwarding Service Requested; 3 - Change Service Requested; 4 - Return Service Requested
type: string
enum:
- '1'
- '2'
- '3'
- '4'
customs_info:
items:
$ref: '#/components/schemas/customs_line'
type: array
declared_value:
type: number
insured_value:
type: number
insurance_type:
type: string
enum:
- dhl_ecommerce
shipping_method:
type: string
notify_bill_to:
type: boolean
default: false
notify_ship_to:
type: boolean
default: false
reference_id:
description: Identifier for a Return Order (RMA)
type: string
reference_number:
type: string
ship_date:
type: string
format: date-time
receiver_tax_info:
$ref: '#/components/schemas/tax_info'
ship_from:
description: The ship_from address is used as the originating address of the rate and label request.
$ref: '#/components/schemas/v1_address'
ship_to:
description: The to address is used as the destination address of a return order rate and label request.
$ref: '#/components/schemas/v1_address'
return:
type: boolean
default: false
return_reason:
description: reason for return if return is true
type: string
required:
- shipper_id
- shipping_method
post_fedex_label:
title: Fedex Label Request Schema
type: object
additionalProperties: false
properties:
alcohol_shipment_license:
type: string
alternate_return_to_address:
$ref: '#/components/schemas/v1_address'
b13a_filing_option:
description: Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands
enum:
- NOT_REQUIRED
- MANUALLY_ATTACHED
- FILED_ELECTRONICALLY
- SUMMARY_REPORTING
- FEDEX_TO_STAMP
type: string
cod:
type: object
properties:
collection_type:
type: string
enum:
- ANY
- CASH
- GUARANTEED_FUNDS
- COMPANY_CHECK
- PERSONAL_CHECK
amount:
type: number
declared_value:
description: Package level Insured Value for Fedex
type: number
reference_number:
description: Package level reference, not always necessarily a number
type: string
packages:
type: array
maxItems: 99
items:
additionalProperties: false
type: object
properties:
box_shape:
type: string
declared_value:
description: Package level Insured Value for Fedex
type: number
description:
type: string
dry_ice_weight:
description: Weight in ounces.
type: number
default: 0
height:
description: Height in inches
type: number
length:
description: Length in inches
type: number
reference_number:
description: Package level reference, not always necessarily a number
type: string
department:
description: Department number. Displayed as DEPT field on label
type: string
maxLength: 40
invoice:
description: Invoice number. Displayed as INV field on label
type: string
maxLength: 40
purchase_order:
description: Purchase order number. Displayed as PO field on label
type: string
maxLength: 40
sub_package_type:
description: 'if you are using your own packaging for the shipment. Example: TUBE, CARTON, CONTAINER. etc'
type: string
weight:
description: Weight in ounces.
type: number
width:
description: Width in inches
type: number
required:
- box_shape
packing_list_id:
description: id for packing list for profile template associated with this label
type: integer
customs_info:
items:
$ref: '#/components/schemas/customs_line'
type: array
delivery_confirmation:
default: SERVICE_DEFAULT
enum:
- NO_SIGNATURE_REQUIRED
- INDIRECT
- DIRECT
- ADULT
- SERVICE_DEFAULT
type: string
delivery_instructions:
type: string
dry_ice_weight:
description: Weight in ounces.
type: number
default: 0
duties_payment_type:
type: string
duties_payment_account:
type: string
export_compliance_statement:
description: For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
type: string
importer_of_record:
type: object
additionalProperties: false
properties:
address:
$ref: '#/components/schemas/address'
tin:
type: object
additionalProperties: false
properties:
tin_type:
type: string
enum:
- BUSINESS_NATIONAL
- BUSINESS_STATE
- BUSINESS_UNION
- PERSONAL_NATIONAL
- PERSONAL_STATE
number:
type: string
maxLength: 15
required:
- tin_type
- number
account_number:
type: string
maxLength: 12
required:
- address
- tin
insurance_type:
enum:
- discounted_insurance
- fedex
type: string
insured_value:
default: 0
type: number
label_type:
description: 'FedEx: option for Tire Loss labels with doc tab'
type: string
enum:
- STOCK_4X85_TRAILING_DOC_TAB
- STOCK_4X105_TRAILING_DOC_TAB
notify
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/openapi/ordoro-return-order-label-api-openapi.yml