RTV Vendor API (2.0.0)

Download OpenAPI specification:Download

Returns Management - Storage: returns-management@optoro.com

Retailers typically have Return To Vendor (RTV) agreements with their suppliers that cover how much unsold or returned inventory can be returned to the supplier for a set refund. The Vendor API endpoint lets clients provide Optoro with data on their Return To Vendor agreements so Optoro can ensure these high value agreements are fully utilized as fast as possible. The Vendor API allows the creation and modification of vendor data. This API is meant to update a single vendor record at a time. The updates can also control the default eligibility of the vendor.

Create or update a vendor

A vendor is identified by its vendor identifier. If a vendor is found the vendor is updated with the provided data. If a vendor is not found, a new one is created.

SecurityoAuth2

Request

Request Body schema: application/json

object

name

required

string non-empty

vendor_identifier

required

string non-empty

eligibility

string

Enum: "forced" "eligible" "prohibited"

additional_policy

string

Enum: "null" "vendor_allowance" "debit_and_destroy"

notes

string

manufacturer_name

string

billing_info

string

object

name	string
email	string
phone	string

object

address_1	string
address_2	string
address_3	string
city	string
state	string
country	string
postal_code	string
name	string
phone	string

web_portal_url

string <= 255 characters

payment_option

string

Enum: "prepaid" "collect" "third-party-billing"

object

type	string Enum: "static" "generated"
value	string

handling_instructions

string <= 255 characters

Deprecated: use notes field instead

expected_credit_percent

string

requires_approval

boolean

Responses

201

Vendor was successfully created.

202

Vendor was successfully updated.

400

Bad Request. Check structure of JSON payload.

401

Missing, expired, or invalid OAuth bearer token. Request a new token from the auth service.

422

Validation error. Fix request payload and try again.

500

Internal Server Error.

502

Bad Gateway.

503

Service Unavailable.

504

Gateway Timeout.

post/vendor_updates

Request samples

Payload

application/json

{"vendor_update": {"name": "Abc Vendors",
"vendor_identifier": "abc-vendors",
"eligibility": "forced",
"additional_policy": "vendor_allowance",
"notes": "Only accepts shipments on Tuesdays.",
"manufacturer_name": "ABC Vendors Inc.",
"billing_info": "credit",
"vendor_contact": {"name": "Abc Vendors",
"email": "abcvendors@gmail.com",
"phone": "2234842321"
},
"shipping_address": {"address_1": "444 Mayflower St",
"address_2": "Apt 422",
"address_3": "PO 1",
"city": "Lake Winnipeg",
"state": "IL",
"country": "US",
"postal_code": "60660",
"name": "Abc Vendors",
"phone": "8332212312"
},
"web_portal_url": "http://abcvendors.com",
"payment_option": "prepaid",
"open_ra_number": {"type": "static",
"value": "134"
},
"handling_instructions": "Handled with the utmost care.",
"expected_credit_percent": "12",
"requires_approval": true
}
}

Response samples

application/json

{"id": 12
}