Returns API

Returns API

POST /{retailer}/returns

Path variables

retailer

string required

retailer moniker example : gap, levi

Request parameters

locale

string optional

Example:

en_US

version

string optional

Example:

1

Request body

Object

address_line1

string

address_line2

string

carrier

string

city

string

country

string

customer_id

integer

email

string

estimated_refund

integer

first_name

string

gift

boolean

gift_email_address

string

itemID_field

string

last_name

string

number_of_packages

integer

order_id

integer

order_number

string

phone_number

string

pickup_date

string

postal_code

string

province

string

reason_details

string

requested_rma_number

string

retailer_return_reason_code

string

return_carrier

string

Example:

ups

return_items

Array

Object

blind_item

boolean

brand

string

clearance_sale

boolean

display_default_properties

boolean

final_sale

boolean

fulfillment_status

string

ineligibilityInfo

unknown nullable

itemName

string

itemProperties

unknown nullable

itemStatus

string

itemWarning

string

item_category

string

item_desc

string

item_gift

boolean

item_gift_card

boolean

item_id

integer

Example:

101647

item_name

string

Example:

Narvar QA Order

item_price

number

Example:

9.99

item_qty

integer

Example:

10

ltl

boolean

orderInfoId

integer

Example:

68962

order_number

string

personalized

boolean

product

string

Example:

return

product_id

string

product_image_url

string

product_sku

string

refund_method

string

remaining_qty

integer

Example:

10

repair_eligibility

boolean

return_desc

string

return_eligibility

boolean

Example:

true

return_eligibility_message

string

Example:

Item has been shipped

return_qty

integer

Example:

1

return_reason_code_id

integer

Example:

662600

return_reason_codes

Array

Object

is_nested

boolean

nested

boolean

reason_category

string

Example:

Arrived Too Late

return_reasons

Array

Object

display_name

string

Example:

Arrived Too Late

display_order

integer

Example:

1

reason_code

integer

Example:

1

return_reason_code_id

integer

Example:

662600

return_reason_settings_json

string

Example:

{}

returned

boolean

selected

boolean

Example:

true

total_price

number

Example:

9.99

user_comment

string

return_method

string

Example:

pickup

return_override_code

unknown nullable

return_to_dc

string

rma_number

string

shipping_method

string

simple_return

boolean

simple_return_reason

string

store_number

string

show more

Responses

200 OK

Body

Object

error_response

Object

error_code

unknown nullable

error_message

unknown nullable

error_message_detail

unknown nullable

error_message_detail_code

unknown nullable

return_process_info

Object

carrier_moniker

string

Example:

fedex

encrypted_return_id

string

Example:

JqZlPK3lZDZo3Waj

order_number

string

partner_return_code

unknown nullable

partner_tracking_number

unknown nullable

product_type

string

Example:

returns

refund_method

unknown nullable

return_address

Object

to_address1

string

to_address2

string

to_city

string

to_company

string

to_country

string

Example:

US

to_country_code

string

Example:

US

to_email

string

Example:

US

to_first_name

string

to_last_name

string

to_name

string

Example:

Returns

to_phone

string

to_state

string

Example:

CA

to_zip4

string

to_zip5

string

Example:

94105

return_carrier

string

Example:

fedex

return_date

integer

Example:

1647331429897

return_method

string

Example:

mail

return_status

string

Example:

returned

return_tracking_number

unknown nullable

return_tracking_status

unknown nullable

rma_number

string

Example:

RA

ship_by_date

string

Example:

2022-03-07T21:29:49Z

shipping_fee

unknown nullable

tracking_number

string

Example:

270868348220

show more