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.
openapi: 3.0.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
post_pitney_label:
title: Pitney Label Request Schema
additionalProperties: false
properties:
alternate_return_to_address:
$ref: '#/components/schemas/v1_address'
customs_info:
items:
$ref: '#/components/schemas/customs_line'
type: array
delivery_confirmation:
enum:
- DelCon
- Sig
- ADSIG
- ADSIGRD
- SigRD
type: string
hazmat_type:
description: USPS hazmat input type options
type: string
hazmat_electronics:
description: ' USPS hazmat option for electronics'
type: boolean
insurance_type:
enum:
- discounted_insurance
type: string
insured_value:
type: number
mailing_zip_code:
description: mailing post office zip code if different than from address zip code
type: string
non_delivery:
enum:
- return
- abandon
- redirect
type: string
notify_bill_to:
default: false
type: boolean
notify_ship_to:
default: false
type: boolean
packages:
description: This should always be an array of 1, as USPS does not allow for multiple package shipments at this time
items:
additionalProperties: false
properties:
box_shape:
type: string
height:
description: Height in inches
type: number
length:
description: Length in inches
type: number
weight:
description: Weight in ounces
type: number
width:
description: Width in inches
type: number
required:
- box_shape
- weight
type: object
type: array
parcel_characteristics:
description: For nonstandard packages
type: string
packing_list_id:
description: id for packing list for profile template associated with this label
type: integer
pitney_rate_type:
type: string
rate_cost:
type: number
reason_for_export:
enum:
- GIFT
- COMMERCIAL_SAMPLE
- MERCHANDISE
- DOCUMENTS
- RETURNED_GOODS
- OTHER
type: string
reason_for_export_explanation:
type: string
sender_tax_info:
$ref: '#/components/schemas/tax_info'
reference_id:
description: Identifier for a Return Order
type: string
reference_number:
type: string
return:
type: boolean
ship_date:
format: date-time
type: string
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'
shipper_id:
type: integer
shipping_method:
$ref: '#/components/schemas/pitney_shipping_methods'
warehouse_id:
description: Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
type: integer
required:
- shipper_id
- shipping_method
type: object
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
tax_info:
title: Tax Info Schema
type: object
additionalProperties: false
properties:
tax_id_number:
type: string
tax_id_type:
type: string
tax_issuer_country:
type: string
required:
- tax_id_number
- tax_id_type
post_dhl_label:
title: DHL Label Request schema
type: object
additionalProperties: false
properties:
shipper_id:
type: integer
weight:
description: Weight in ounces
type: number
length:
description: Length in inches
type: integer
width:
description: Width in inches
type: integer
height:
description: Height in inches
type: integer
box_shape:
description: optional box type [FLY=Flyer/Smalls - pieces that are too small, thin or light to be sorted on a standard conveyor, or for which it makes sense to group pieces into larger units for sort purposes. COY=Parcels/Conveyables - pieces that can be handled onto a system, less than 31.5 kg and up to 60*60*120cm. NCY=Non-conveyables - Pieces that cannot on their own be sorted on standard conveyor. PAL=Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. DBL=Double Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. BOX=Parcels that are conveyable have the shape of a box. Up to 70kg.]
type: string
enum:
- FLY
- COY
- NCY
- PAL
- DBL
- BOX
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:
description: Package Level Declared Value for Dutiable International Shipments
type: number
box_shape:
description: optional box type [FLY=Flyer/Smalls - pieces that are too small, thin or light to be sorted on a standard conveyor, or for which it makes sense to group pieces into larger units for sort purposes. COY=Parcels/Conveyables - pieces that can be handled onto a system, less than 31.5 kg and up to 60*60*120cm. NCY=Non-conveyables - Pieces that cannot on their own be sorted on standard conveyor. PAL=Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. DBL=Double Pallets - large, irregular or heavy pieces, Palletized with weight upto 1000 KG. BOX=Parcels that are conveyable have the shape of a box. Up to 70kg.]
type: string
enum:
- FLY
- COY
- NCY
- PAL
- DBL
- BOX
required:
- length
- width
- height
- weight
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
reason_for_export:
description: '[P - Permanent, T - Temporary, R - Re-Export] It is required for dutiable shipment.'
type: string
default: P
reason_for_export_explanation:
type: string
declared_value:
description: Shipment Level Declared Value for Dutiable International Shipments
type: number
insured_value:
type: number
insurance_type:
type: string
enum:
- dhl
shipping_method:
$ref: '#/components/schemas/dhl_service_types'
notify_bill_to:
type: boolean
default: false
notify_ship_to:
type: boolean
default: false
ship_date:
type: string
format: date-time
pickup:
description: pickup date time to schedule for the carrier
type: string
format: date-time
signature_service:
description: signature service option. Signature services are included in international shipments. Use `SX` for no signature required
type: string
enum:
- SX
nonstandard_day:
description: options are [AA - Saturday Delivery, AB - Saturday Pickup, AC - Holiday Delivery, AD - Holiday Pickup, AG - Domestic Saturday Delivery]
type: string
enum:
- AA
- AB
- AC
- AD
- AG
nonstandard_contents:
description: options are [HB - Lithium Ion PI965 Section II, HC - Dry Ice UN1845, HD - Lithium Ion PI965-966 Section II, HE - Dangerous Goods, HG - Perishable Cargo, HH - Excepted Quantity, HI - Spill Cleaning, HK - Consumer Commodities, HL - Limited Quantities ADR, HM - Lithium Metal PI969 Section II, HN - ADR Load Exemption, HV - Lithium Ion PI967-Section II, HW - Lithium Metal PI970-Section II, HY - Biological UN3373]
type: string
enum:
- HB
- HC
- HD
- HE
- HG
- HH
- HI
- HK
- HL
- HM
- HN
- HV
- HW
- HY
is_dutiable:
type: boolean
default: true
federal_tax_id:
description: Mandatory for domestic shipment of country code = BR
type: string
maxLength: 20
state_tax_id:
description: Mandatory for domestic shipment of country code = BR
type: string
maxLength: 20
duty_payment_type:
type: string
description: Duties may be paid via Shipper [S], Recipient [R], or Third Party [T]
default: R
enum:
- S
- R
- T
reference_id:
description: Identifier for a Return Order
type: string
reference_number:
type: string
sender_tax_info:
type: object
additionalProperties: false
properties:
tax_id_number:
type: string
tax_id_type:
type: string
tax_issuer_country:
type: string
required:
- tax_id_number
- tax_id_type
- tax_issuer_country
receiver_tax_info:
type: object
additionalProperties: false
properties:
tax_id_number:
type: string
tax_id_type:
type: string
tax_issuer_country:
type: string
required:
- tax_id_number
- tax_id_type
- tax_issuer_country
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
warehouse_id:
description: Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.
type: integer
shipping_payment_type:
type: string
description: Shipping may be paid via Shipper [S], Recipient [R], or Third Party [T]
default: S
enum:
- S
- R
- T
shipping_payment_account:
type: string
description: Shipment bill to account
duty_payment_account:
type: string
description: Duty bill to account
foreign_trade_regulation:
type: string
description: Foreign trade regulation code
enum:
- 30.2(d)(2)
- '30.36'
- 30.37(a)
- 30.37(b)
- 30.37(e)
- 30.37(f)
- 30.37(g)
- 30.37(h)
- 30.37(i)
- 30.37(k)
- 30.37(o)
- 30.37(q)
- 30.37(r)
- '30.39'
- 30.40(a)
- 30.40(b)
- 30.40(c)
- 30.40(d)
internal_transaction_number:
type: string
description: Internal transaction number provided by the US Customs AES System
minLength: 14
maxLength: 14
required:
- shipper_id
- shipping_method
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
ty
# --- 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