Proposals
A Proposal is a group of vendor variants that the retail buyer and the vendor's salesperson are considering offering via the retailer's dropship program. Proposals can exist in various states of negotiation between buyer and seller. For most use cases, it is recommended to programmatically operate on "approved" proposals only, as approved proposals can no longer change via the RevCascade Console.
Operations
Click on an operation (or scroll down) to view requirements, options, & examples for each operation.
| GET | /v1/retailers/{retailer_id}/proposals/ | Get a list of proposals |
|---|---|---|
| GET | /v1/retailers/{retailer_id}/proposals/{id}/ | Get a single proposals |
| GET | /v1/retailers/{retailer_id}/proposals/{id}/variants/ | Get a proposal's variants |
| PUT | /v1/retailers/{retailer_id}/proposals/{id}/acknowledge/ | Acknowledge proposals |
Proposal Properties
The following is a list of ALL proposal properties. For a list of properties required for a specific request, please review the example operations.
| Name | Description |
|---|---|
|
id integer (11) |
Static identifier for the proposal assigned by RevCascade. Should be used as the {id} in other proposal endpoints. |
|
name string (128) |
The name of the proposal. |
|
status string (32) |
The current status of the proposal:
|
|
recipient user object |
The original recipient of the proposal. Can be either a retailer user or a vendor user depending on which party initiated the proposal. |
|
sender user object |
The original sender of the proposal. Can be either a retailer user or a vendor user depending on which party initiated the proposal. |
|
created_by user object |
The original author of the proposal. Can be either a retailer user or a vendor user depending on which party initiated the proposal. |
|
memos array of memos |
An array of memos and comments added to the proposal by retailer or brand users. |
|
connection |
The relationship between the brand/vendor and the retailer. |
|
brand |
The brand that owns the proposal. Please note that proposals do no require connections, although for most use cases, connections will be present. |
|
updated_at ISO-8601 Datetime |
The date and time (in UTC) that the proposal was last updated. |
|
created_at ISO-8601 Datetime |
The date and time (in UTC) that the proposal was created. |
|
acknowledged_at ISO-8601 Datetime |
The date and time (in UTC) that the proposal was acknowledged. |
|
item_count integer (11) |
The number of variants on the proposal. |
|
has_revision boolean |
Boolean flag that indicates whether a proposal has changed since it was sent to the brand. Proposals cannot be modified once they are approved. |
|
action_required boolean |
Boolean flag that indicates whether a proposal requires attention from the retailer. |
|
collaborators array of users |
The set of users from both brand and retailer that have permission to operate on the proposal. |
|
available_collaborators array of users |
A set of users from the retailer's account that can be, but have not yet been, granted permission to operate on the proposal. |
Operation Details & Examples
| GET | /v1/retailers/{retailer_id}/proposals/ | Get a list of all proposals. |
|---|
| Optional Query String Parameters | |
|
is_acknowledged boolean |
Boolean filter that returns proposals based on whether or not they have been processed
by the retailer.
1 - show only only proposals that have been acknowledged. 0 - show proposals that have not been acknowledged. |
|
status string |
Return proposals based on the proposal status.
approved - return proposals that have been approved by both sides. |
|
limit integer (3) |
Customize the number of results return (max 250). |
|
Get all recently "approved" proposals. GET https://api.revcascade.com/v1/retailers/500/proposals/?status=approved&is_acknowledged=0 |
|
| GET | /v1/retailers/{retailer_id}/proposals/{id} | Get a single proposal. |
|---|
|
Get a single proposal using the RevCascade proposal id. GET https://api.revcascade.com/v1/retailers/500/proposal/10065/ |
| GET | /v1/retailers/{retailer_id}/proposals/{id}/variants/ | Get a single proposal. |
|---|
|
Get all of the variants that are part of a proposal. GET https://api.revcascade.com/v1/retailers/500/proposal/10065/variants/ Please Note: This request will return only an array of variants. No other details about the proposal will be returned. |
| PUT | /v1/retailers/{retailer_id}/proposals/{id}/acknowledge/ | Acknowledge receipt |
|---|
|
Acknowledge receipt of an approved proposal. PUT https://api.revcascade.com/v1/retailers/500/proposals/123645/acknowledge/ Please Note: This request will only succeed if the proposal is approved. |