Connections

A Connection represents a relationship between a Retailer and a Vendor on the RevCascade platform. Use the connections endpoint to look up data about the relationship such as the allowed shipping methods and other connection-specific settings and credentials.

Operations

Click on an Operation to view requirements, options, & examples.

GET /v1/retailers/{retailer_id}/connections/ Get a list of Connections
GET /v1/retailers/{retailer_id}/connections/{id}/ Get a single Connection
Connection Properties
Name Description

id

integer (11)

A static id assigned by RevCascade. Can be used as the primary key in the url of other connection endpoints.

brand

brand

The brand or vendor attached to the connection.

"brand": {
    "id": 1000,
    "name": "Demo Brand"
    ...
}

level

string (16)

The relationship level of the connection. Values include:

  •   •   Full - the connection is live approved for transactions.
      •   Basic - the connection is live, but not yet enabled for transactions.

status

string (16)

The current status of the connection. Values include:

  •   •   Active - the connection is live.
      •   Pending - the connection is waiting for activation.
      •   Suspended - the connection has been placed on hold.

connection_credentials

array of objects

Array of settings associated with the connection. This array is only returned in the detail route and will also only contain keys relevant to your circumstances and requirements.

shipping_methods

array of shipping methods

Array of shipping methods authorized for use with this connection.

"shipping_methods": [{
    "id": 1,
    "name": "UPS Ground",
    "code": "Ground",
    "type": "small_parcel",
    "carrier": {
      "id": 2,
      "name": "UPS",
      "code": "UPSN"
    },
    "generic_shipping_method": null
}]

Back to Top

Operation Details & Examples
GET /v1/retailers/connections/ Get a list of connections
Optional Query String Parameters

brand_id

integer (11)

Filter connections using a brand id.

Get all connections

GET https://api.revcascade.com/v1/retailers/500/connections/

Lookup a connection using a brand id.

GET https://api.revcascade.com/v1/retailers/500/connections/?brand_id=500

Back to Top

GET /v1/retailers/{retailer_id}/connections/{id}/ Get a single Connection

Get a single connection by its ID.

GET https://api.revcascade.com/v1/retailers/500/connections/103547/

Back to Top

powered by