eCellar Exchange REST API

https://exchange.ecellar-api.com/v1/docs
Admin
The eCellar Exchange REST API provides programmatic access to manage customer records, wine club...
Tokens:5,964
Snippets:82
Trust Score:4.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /client/customertags

Source: https://exchange.ecellar-api.com/v1/docs

Get Customer Tags

```APIDOC
## GET /client/customertags

### Description
Get Customer Tags

### Method
GET

### Endpoint
/client/customertags

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/terminals

Source: https://exchange.ecellar-api.com/v1/docs

Get Client Terminals

```APIDOC
## GET /client/terminals

### Description
Get Client Terminals

### Method
GET

### Endpoint
/client/terminals

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/customersources

Source: https://exchange.ecellar-api.com/v1/docs

Get Customer Sources

```APIDOC
## GET /client/customersources

### Description
Get Customer Sources

### Method
GET

### Endpoint
/client/customersources

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/productstatuses

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of product statuses.

```APIDOC
## [GET] /types/productstatuses

### Description
Get Product Statuses

### Method
GET

### Endpoint
/types/productstatuses

```

--------------------------------

### GET /types/productavailabilities

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of product availabilities.

```APIDOC
## [GET] /types/productavailabilities

### Description
Get Product Availabilities

### Method
GET

### Endpoint
/types/productavailabilities

```

--------------------------------

### GET /client/brands

Source: https://exchange.ecellar-api.com/v1/docs

Get Client Brands

```APIDOC
## GET /client/brands

### Description
Get Client Brands

### Method
GET

### Endpoint
/client/brands

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/customertypes

Source: https://exchange.ecellar-api.com/v1/docs

Get Customer Types

```APIDOC
## GET /client/customertypes

### Description
Get Customer Types

### Method
GET

### Endpoint
/client/customertypes

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/locations

Source: https://exchange.ecellar-api.com/v1/docs

Get Client Locations

```APIDOC
## GET /client/locations

### Description
Get Client Locations

### Method
GET

### Endpoint
/client/locations

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/ordertags

Source: https://exchange.ecellar-api.com/v1/docs

Get Order Tags

```APIDOC
## GET /client/ordertags

### Description
Get Order Tags

### Method
GET

### Endpoint
/client/ordertags

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /client/reservationtypes

Source: https://exchange.ecellar-api.com/v1/docs

Get Client Reservation Types

```APIDOC
## GET /client/reservationtypes

### Description
Get Client Reservation Types

### Method
GET

### Endpoint
/client/reservationtypes

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/purchasesources

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of purchase sources.

```APIDOC
## [GET] /types/purchasesources

### Description
Get Purchase Sources

### Method
GET

### Endpoint
/types/purchasesources

```

--------------------------------

### GET /types/carriers

Source: https://exchange.ecellar-api.com/v1/docs

Get Carrier Types

```APIDOC
## GET /types/carriers

### Description
Get Carrier Types

### Method
GET

### Endpoint
/types/carriers

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/billingstatuses

Source: https://exchange.ecellar-api.com/v1/docs

Get Billing Statuses

```APIDOC
## GET /types/billingstatuses

### Description
Get Billing Statuses

### Method
GET

### Endpoint
/types/billingstatuses

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/fulfillmentcompanies

Source: https://exchange.ecellar-api.com/v1/docs

Get Fulfillment Companies

```APIDOC
## GET /types/fulfillmentcompanies

### Description
Get Fulfillment Companies

### Method
GET

### Endpoint
/types/fulfillmentcompanies

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/cards

Source: https://exchange.ecellar-api.com/v1/docs

Get Card Types

```APIDOC
## GET /types/cards

### Description
Get Card Types

### Method
GET

### Endpoint
/types/cards

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/purchasestatuses

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of purchase statuses.

```APIDOC
## [GET] /types/purchasestatuses

### Description
Get Purchase Statuses

### Method
GET

### Endpoint
/types/purchasestatuses
```

--------------------------------

### GET /types/countrycodes

Source: https://exchange.ecellar-api.com/v1/docs

Get Country Codes

```APIDOC
## GET /types/countrycodes

### Description
Get Country Codes

### Method
GET

### Endpoint
/types/countrycodes

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### GET /types/reservationstatuses

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of reservation statuses.

```APIDOC
## [GET] /types/reservationstatuses

### Description
Get Reservation Statuses

### Method
GET

### Endpoint
/types/reservationstatuses
```

--------------------------------

### GET /types/statecodes

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of state codes.

```APIDOC
## [GET] /types/statecodes

### Description
Get State Codes

### Method
GET

### Endpoint
/types/statecodes
```

--------------------------------

### GET /types/payments

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of payment types.

```APIDOC
## [GET] /types/payments

### Description
Get Payment Types

### Method
GET

### Endpoint
/types/payments

```

--------------------------------

### GET /types/notes

Source: https://exchange.ecellar-api.com/v1/docs

Retrieves the list of note types available in the eCellar Exchange system.

```APIDOC
## [GET] /types/notes

### Description
Get Note Types

### Method
GET

### Endpoint
/types/notes

```

--------------------------------

### POST /product

Source: https://exchange.ecellar-api.com/v1/docs

Create Product

```APIDOC
## POST /product

### Description
Create Product

### Method
POST

### Endpoint
/product

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /products

Source: https://exchange.ecellar-api.com/v1/docs

Search Products

```APIDOC
## POST /products

### Description
Search Products

### Method
POST

### Endpoint
/products

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PUT /product/{product_id}

Source: https://exchange.ecellar-api.com/v1/docs

Update Product

```APIDOC
## PUT /product/{product_id}

### Description
Update Product

### Method
PUT

### Endpoint
/product/{product_id}

### Parameters
#### Path Parameters
- **product_id** (string) - Required - The ID of the product to update.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /products/categories

Source: https://exchange.ecellar-api.com/v1/docs

Search Product Categories

```APIDOC
## POST /products/categories

### Description
Search Product Categories

### Method
POST

### Endpoint
/products/categories

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /customers

Source: https://exchange.ecellar-api.com/v1/docs

Search Customers

```APIDOC
## POST /customers

### Description
Search Customers

### Method
POST

### Endpoint
/customers

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /order/{order_id}/tracking

Source: https://exchange.ecellar-api.com/v1/docs

Create Order Tracking Record

```APIDOC
## POST /order/{order_id}/tracking

### Description
Create Order Tracking Record

### Method
POST

### Endpoint
/order/{order_id}/tracking

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /inventory/SKU/{SKU}

Source: https://exchange.ecellar-api.com/v1/docs

Adjust Inventory SKU

```APIDOC
## PATCH /inventory/SKU/{SKU}

### Description
Adjust Inventory SKU

### Method
PATCH

### Endpoint
/inventory/SKU/{SKU}

### Parameters
#### Path Parameters
- **SKU** (string) - Required - The SKU of the inventory item to adjust.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /reservations

Source: https://exchange.ecellar-api.com/v1/docs

Search Reservations

```APIDOC
## POST /reservations

### Description
Search Reservations

### Method
POST

### Endpoint
/reservations

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /notes

Source: https://exchange.ecellar-api.com/v1/docs

Search Customer Notes

```APIDOC
## POST /notes

### Description
Search Customer Notes

### Method
POST

### Endpoint
/notes

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /subscriptions

Source: https://exchange.ecellar-api.com/v1/docs

Search Customer Club Subscriptions

```APIDOC
## POST /subscriptions

### Description
Search Customer Club Subscriptions

### Method
POST

### Endpoint
/subscriptions

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /inventory/counts

Source: https://exchange.ecellar-api.com/v1/docs

Search Inventory Counts

```APIDOC
## POST /inventory/counts

### Description
Search Inventory Counts

### Method
POST

### Endpoint
/inventory/counts

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /inventory/counts/{SKU}

Source: https://exchange.ecellar-api.com/v1/docs

Adjust Inventory Count

```APIDOC
## PATCH /inventory/counts/{SKU}

### Description
Adjust Inventory Count

### Method
PATCH

### Endpoint
/inventory/counts/{SKU}

### Parameters
#### Path Parameters
- **SKU** (string) - Required - The SKU of the inventory count to adjust.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /orders

Source: https://exchange.ecellar-api.com/v1/docs

Search Orders

```APIDOC
## POST /orders

### Description
Search Orders

### Method
POST

### Endpoint
/orders

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /orders/lines

Source: https://exchange.ecellar-api.com/v1/docs

Search Order Lines

```APIDOC
## POST /orders/lines

### Description
Search Order Lines

### Method
POST

### Endpoint
/orders/lines

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /order/{order_id}/tracking/{carrier_tracking_number}/shipped

Source: https://exchange.ecellar-api.com/v1/docs

Order Tracking Shipped

```APIDOC
## PATCH /order/{order_id}/tracking/{carrier_tracking_number}/shipped

### Description
Order Tracking Shipped

### Method
PATCH

### Endpoint
/order/{order_id}/tracking/{carrier_tracking_number}/shipped

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.
- **carrier_tracking_number** (string) - Required - The carrier tracking number.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /club/events

Source: https://exchange.ecellar-api.com/v1/docs

Search Club Events

```APIDOC
## POST /club/events

### Description
Search Club Events

### Method
POST

### Endpoint
/club/events

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /order/{order_id}/shipped

Source: https://exchange.ecellar-api.com/v1/docs

Order Shipped

```APIDOC
## PATCH /order/{order_id}/shipped

### Description
Order Shipped

### Method
PATCH

### Endpoint
/order/{order_id}/shipped

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /addresses

Source: https://exchange.ecellar-api.com/v1/docs

Search Customer Addresses

```APIDOC
## POST /addresses

### Description
Search Customer Addresses

### Method
POST

### Endpoint
/addresses

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /club/tiers

Source: https://exchange.ecellar-api.com/v1/docs

Search Club Tiers

```APIDOC
## POST /club/tiers

### Description
Search Club Tiers

### Method
POST

### Endpoint
/club/tiers

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /orders/trackings

Source: https://exchange.ecellar-api.com/v1/docs

Search Order Tracking Records

```APIDOC
## POST /orders/trackings

### Description
Search Order Tracking Records

### Method
POST

### Endpoint
/orders/trackings

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /order/{order_id}/delivered

Source: https://exchange.ecellar-api.com/v1/docs

Order Delivered

```APIDOC
## PATCH /order/{order_id}/delivered

### Description
Order Delivered

### Method
PATCH

### Endpoint
/order/{order_id}/delivered

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### PATCH /order/{order_id}/tracking/{carrier_tracking_number}/delivered

Source: https://exchange.ecellar-api.com/v1/docs

Order Tracking Delivered

```APIDOC
## PATCH /order/{order_id}/tracking/{carrier_tracking_number}/delivered

### Description
Order Tracking Delivered

### Method
PATCH

### Endpoint
/order/{order_id}/tracking/{carrier_tracking_number}/delivered

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the order.
- **carrier_tracking_number** (string) - Required - The carrier tracking number.

### Request Example
No request example documented.

### Response
No response example documented.
```

--------------------------------

### POST /orders/payments

Source: https://exchange.ecellar-api.com/v1/docs

Search Order Payments

```APIDOC
## POST /orders/payments

### Description
Search Order Payments

### Method
POST

### Endpoint
/orders/payments

### Parameters
No parameters documented.

### Request Example
No request example documented.

### Response
No response example documented.
```
Tokens:
Raw