Customer Type

Supplier Retailer

Integration Method

API

EDI (docs coming soon!)

API Reference

Catalog

Items (coming soon!)

Inventory

Transactions

Orders Shipments Cancellations Invoices Returns Credit Memos

Helpers

Connections Carriers

Testing & Monitoring

Heartbeat
  2. Retailers
  3. API
  4. Connections

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.

Relationships

  • Brand • Connections have one Brand.
  • Retailer • Connections have one Retailer.

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

Data Fields

messageA static message.
brand

The Supplier attached to the connection. 

{
  "id": 1050,
  "name": "Demo Vendor"
}
level

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

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.
shipping_methods

Array of shipping methods authorized for use with this connection.

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

Back to Top

Examples

GET /v1/retailers/connections/ Get a list of Connections

Get all Connections

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

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