Ochre Fulfilment API

https://ochrefulfilmentapi.docs.apiary.io
Admin
The Ochre Fulfilment API provides access to fulfilment services, with endpoints for mock,...
Tokens:6,098
Snippets:48
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Read Stock

Source: https://ochrefulfilmentapi.docs.apiary.io/

Allows reading stock information using GET parameters or a JSON payload for filtering. Recommended to use JSON payload for larger sku code lists. Results are not paginated.

```APIDOC
## GET /stock

### Description
Reads stock information with filtering capabilities via GET parameters or a JSON payload.

### Method
GET

### Endpoint
/stock

### Query Parameters
- **sku_codes** (string) - Required - List of sku codes separated by ","

### Request Body
- **sku_codes** (array of strings) - Required - List of sku codes.

### Response
#### Success Response (200)
- **sku** (string) - The SKU code.
- **quantity** (integer) - The available quantity.
- **reserved_quantity** (integer) - The reserved quantity.

#### Response Example
```json
{
  "sku": "EXAMPLE-SKU-123",
  "quantity": 100,
  "reserved_quantity": 10
}
```
```

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

### Get Fulfilment Account Profile

Source: https://ochrefulfilmentapi.docs.apiary.io/

Allows retrieving the profile of a specific fulfilment account by its ID.

```APIDOC
## GET /fulfilment/accounts/{id}

### Description
Gets a fulfilment account profile by its ID.

### Method
GET

### Endpoint
/fulfilment/accounts/{id}

### Path Parameters
- **id** (string) - Required - The account ID to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the fulfilment account.
- **name** (string) - The name of the fulfilment account.
- **address** (object) - The address details of the account.
  - **street** (string)
  - **city** (string)
  - **postal_code** (string)
  - **country** (string)

#### Response Example
```json
{
  "id": "acc_12345",
  "name": "Example Fulfilment Account",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "postal_code": "12345",
    "country": "USA"
  }
}
```
```

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

### Get Warehouse Profile

Source: https://ochrefulfilmentapi.docs.apiary.io/

Retrieves the profile of a specific warehouse by its ID.

```APIDOC
## GET /warehouses/{id}

### Description
Gets a warehouse profile by its ID.

### Method
GET

### Endpoint
/warehouses/{id}

### Path Parameters
- **id** (string) - Required - The warehouse ID to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the warehouse.
- **name** (string) - The name of the warehouse.
- **address** (object) - The address details of the warehouse.
  - **street** (string)
  - **city** (string)
  - **postal_code** (string)
  - **country** (string)
- **is_active** (boolean) - Indicates if the warehouse is active.
- **type** (string) - The type of the warehouse.

#### Response Example
```json
{
  "id": "wh_789",
  "name": "Main Distribution Center",
  "address": {
    "street": "456 Warehouse Rd",
    "city": "Distribution City",
    "postal_code": "67890",
    "country": "USA"
  },
  "is_active": true,
  "type": "distribution"
}
```
```

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

### Search Warehouses

Source: https://ochrefulfilmentapi.docs.apiary.io/

Lists available warehouses. Search criteria can be set using GET parameters or a JSON object in the request payload. The latter is advised for long lists of SKU codes or statuses.

```APIDOC
## GET /warehouses/search

### Description
Searches for warehouses based on specified criteria. Supports filtering via GET parameters or a JSON request body.

### Method
GET

### Endpoint
/warehouses/search

### Query Parameters
- **fulfilment_account_id** (string) - Optional - Filter by fulfilment account ID.
- **is_active** (boolean) - Optional - Filter by active status.
- **type** (string) - Optional - Specify the type of warehouse to return.
- **limit** (integer) - Optional - Maximum number of results per page.

### Request Body
- **sku_codes** (array of strings) - Optional - List of SKU codes to filter warehouses by.
- **statuses** (array of strings) - Optional - List of statuses to filter warehouses by.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the warehouse.
- **name** (string) - The name of the warehouse.
- **is_active** (boolean) - Indicates if the warehouse is active.
- **type** (string) - The type of the warehouse.

#### Response Example
```json
{
  "id": "wh_789",
  "name": "Main Distribution Center",
  "is_active": true,
  "type": "distribution"
}
```
```

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

### Stock API

Source: https://ochrefulfilmentapi.docs.apiary.io/

The stock resource allows to read and update stock for one or more sku codes. It's designed to cope with bulk operations.

```APIDOC
## __Fulfilment / Stock

### __Bulk

This section details bulk operations for stock management.
```

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

### List Fulfilment Accounts

Source: https://ochrefulfilmentapi.docs.apiary.io/

Allows listing all available fulfilment accounts.

```APIDOC
## GET /fulfilment/accounts

### Description
Lists all available fulfilment accounts.

### Method
GET

### Endpoint
/fulfilment/accounts

### Query Parameters
- **limit** (integer) - Optional - Maximum number of results per page.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the fulfilment account.
- **name** (string) - The name of the fulfilment account.

#### Response Example
```json
{
  "id": "acc_12345",
  "name": "Example Fulfilment Account"
}
```
```

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

### Customer Returns API

Source: https://ochrefulfilmentapi.docs.apiary.io/

Endpoints for managing customer returns, including listing, creating, and updating.

```APIDOC
## GET /websites/ochrefulfilmentapi_apiary_io/returns

### Description
Lists all available customer returns. The search criteria can be set with GET parameters or sent in the request payload as a JSON object.

### Method
GET

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/returns

### Parameters
#### Query Parameters
- **fulfilment_account_id** (string) - Optional - Fulfilment account ID
- **shipment_id** (string) - Optional - Shipment ID
- **sku_codes** (string) - Optional - List of sku codes separated by **,** (comma)
- **status** (string) - Optional - List of statuses separated by **,** (comma) (`ordered`, `arrived`, `processing`, `delivered`)
- **return_reason** (string) - Optional - List of return reasons separated by **,** (comma) (`postage_returned`, `wrong_item_sent`, `wrong_item_bought`, `customer_rejected`, `item_arrived_damaged`, `too_big`, `too_small`, `order_more_choice`, `not_as_described`, `changed_mind`, `other_return_reason`)
- **external_id** (string) - Optional - External identifier
- **from** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **to** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **updated_from** (string) - Optional - Date with format 'yyyyMMdd' - Date updated
- **updated_to** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Maximum number of results per page.

### Response
#### Success Response (200 OK)

```

```APIDOC
## POST /websites/ochrefulfilmentapi_apiary_io/returns

### Description
Adds a new customer return to the collection.

### Method
POST

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/returns

### Response
#### Success Response (201 Created)

```

```APIDOC
## GET /websites/ochrefulfilmentapi_apiary_io/returns/{id}

### Description
Gets a customer return profile by ID.

### Method
GET

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/returns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer return ID

### Response
#### Success Response (200 OK)

```

```APIDOC
## PUT /websites/ochrefulfilmentapi_apiary_io/returns/{id}

### Description
Update a customer return profile by ID.

### Method
PUT

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/returns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer return ID

### Response
#### Success Response (200 OK)

```

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

### List Fulfilment Channels

Source: https://ochrefulfilmentapi.docs.apiary.io/

Allows listing fulfilment channels, filterable by fulfilment account ID or store ID.

```APIDOC
## GET /fulfilment/channels

### Description
Lists available fulfilment channels. Can be filtered by fulfilment account ID or store ID.

### Method
GET

### Endpoint
/fulfilment/channels

### Query Parameters
- **fulfilment_account_id** (string) - Optional - Filter by fulfilment account ID.
- **store_id** (string) - Optional - Filter by store ID.
- **limit** (integer) - Optional - Maximum number of results per page.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the fulfilment channel.
- **name** (string) - The name of the fulfilment channel.
- **fulfilment_account_id** (string) - The ID of the associated fulfilment account.
- **store_id** (string) - The ID of the associated store.

#### Response Example
```json
{
  "id": "ch_abcde",
  "name": "Online Store Channel",
  "fulfilment_account_id": "acc_12345",
  "store_id": "store_xyz"
}
```
```

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

### SKU Management API

Source: https://ochrefulfilmentapi.docs.apiary.io/

Endpoints for managing Stock Keeping Units (SKUs), including listing, creating, and updating.

```APIDOC
## GET /fulfilment/skus

### Description
Lists SKUs with default sorting by ID. Supports filtering by various parameters.

### Method
GET

### Endpoint
/fulfilment/skus

### Query Parameters
- **fulfilment_account_id** (string) - Required - Fulfilment account ID reference
- **code** (string) - Optional - SKU code
- **from** (string) - Optional - Date created (yyyyMMdd)
- **to** (string) - Optional - Date created (yyyyMMdd)
- **upc** (string) - Optional - UPC reference
- **scancode** (string) - Optional - Scancode reference
- **external_code** (string) - Optional - A code used by selected partner warehouses to identify SKUs within their system
- **has_external_code** (boolean) - Optional - Allows filtering based on the existence of an external code
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Maximum number of results per page

### Response
#### Success Response (200 OK)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
```

```APIDOC
## POST /fulfilment/skus

### Description
Adds a new SKU to the collection.

### Method
POST

### Endpoint
/fulfilment/skus

### Request Body
- **(structure not detailed in source)**

### Response
#### Success Response (201 Created)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
```

```APIDOC
## PUT /fulfilment/skus

### Description
Updates an SKU profile as a whole.

### Method
PUT

### Endpoint
/fulfilment/skus

### Request Body
- **(structure not detailed in source)**

### Response
#### Success Response (202 Accepted)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
```

```APIDOC
## GET /fulfilment/skus/{code}

### Description
Gets a SKU profile by `code`.

### Method
GET

### Endpoint
/fulfilment/skus/{code}

### Path Parameters
- **code** (string) - Required - SKU code

### Query Parameters
- **fulfilment_account_id** (string) - Required - Fulfilment account ID

### Response
#### Success Response (200 OK)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
```

```APIDOC
## PUT /fulfilment/skus/{code}

### Description
Updates an SKU profile as a whole.

### Method
PUT

### Endpoint
/fulfilment/skus/{code}

### Path Parameters
- **code** (string) - Required - SKU code

### Query Parameters
- **fulfilment_account_id** (string) - Required - Fulfilment account ID

### Request Body
- **(structure not detailed in source)**

### Response
#### Success Response (202 Accepted)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
```

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

### Shipment Management API

Source: https://ochrefulfilmentapi.docs.apiary.io/

Endpoints for managing shipments, including listing and creating.

```APIDOC
## GET /fulfilment/shipments

### Description
Lists all available shipments. Search criteria can be set with GET parameters or in the request payload.

### Method
GET

### Endpoint
/fulfilment/shipments

### Query Parameters
- **fulfilment_account_id** (string) - Optional - Fulfilment account ID
- **store_id** (string) - Optional - Store reference ID
- **order_id** (string) - Optional - Order reference ID
- **status** (string) - Optional - List of statuses separated by comma (e.g., `incubating,new,dispatched`)
- **from** (string) - Optional - Date created (yyyyMMdd)
- **to** (string) - Optional - Date created (yyyyMMdd)
- **updated_from** (string) - Optional - Updated date (yyyyMMdd or yyyyMMdd’T’HH:mm:ss’Z')
- **updated_to** (string) - Optional - Updated date (yyyyMMdd or yyyyMMdd’T’HH:mm:ss’Z')
- **dispatch_from** (string) - Optional - Date dispatched (yyyyMMdd)
- **dispatch_to** (string) - Optional - Date dispatched (yyyyMMdd)
- **postage_method_id** (string) - Optional - Postage method ID
- **warehouse_location_id** (string) - Optional - Warehouse location ID
- **sku_codes** (string) - Optional - List of SKU codes separated by comma
- **external_reference_id** (string) - Optional - Extender reference identifier
- **include_items** (boolean) - Optional - Sets if the response should include the shipment items property
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Maximum number of results per page

### Response
#### Success Response (200 OK)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
```

```APIDOC
## POST /fulfilment/shipments

### Description
Adds a new shipment to the collection.

### Method
POST

### Endpoint
/fulfilment/shipments

### Request Body
- **(structure not detailed in source)**

### Response
#### Success Response (201 Created)
- **(structure not detailed in source)**

#### Error Responses
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
```

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

### Advanced Stock Notifications (ASN) API

Source: https://ochrefulfilmentapi.docs.apiary.io/

Endpoints for managing Advanced Stock Notifications (ASNs), including listing, creating, and updating.

```APIDOC
## GET /websites/ochrefulfilmentapi_apiary_io/asns

### Description
Lists all available ASNs. The search criteria can be set with GET parameters or sent in the request payload as a JSON object.

### Method
GET

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/asns

### Parameters
#### Query Parameters
- **fulfilment_account_id** (string) - Optional - Fulfilment account ID
- **sku_codes** (string) - Optional - List of sku codes separated by **,** (comma)
- **status** (string) - Optional - List of statuses separated by **,** (comma) (`ordered`, `delivered`, `cancelled`)
- **external_id** (string) - Optional - External identifier
- **from** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **to** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **updated_from** (string) - Optional - Date with format 'yyyyMMdd' - Date updated
- **updated_to** (string) - Optional - Date with format 'yyyyMMdd' - Date created
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Maximum number of results per page.

### Response
#### Success Response (200 OK)

```

```APIDOC
## POST /websites/ochrefulfilmentapi_apiary_io/asns

### Description
Adds a new ASN to the collection.

### Method
POST

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/asns

### Response
#### Success Response (201 Created)

```

```APIDOC
## GET /websites/ochrefulfilmentapi_apiary_io/asns/{id}

### Description
Gets a ASN profile by ID.

### Method
GET

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/asns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ASN ID

### Response
#### Success Response (200 OK)

```

```APIDOC
## PUT /websites/ochrefulfilmentapi_apiary_io/asns/{id}

### Description
Update ASN profile by ID.

### Method
PUT

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/asns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ASN ID

### Response
#### Success Response (200 OK)

```

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

### Shipment API

Source: https://ochrefulfilmentapi.docs.apiary.io/

Endpoints for managing shipments, including creation, retrieval, and updates.

```APIDOC
## POST /websites/ochrefulfilmentapi_apiary_io/shipments

### Description
Adds a new shipment to the collection.

### Method
POST

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/shipments

### Response
#### Success Response (201 Created)

```

```APIDOC
## GET /websites/ochrefulfilmentapi_apiary_io/shipments/{id}

### Description
Gets a shipment profile by ID.

### Method
GET

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/shipments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Shipment ID

### Response
#### Success Response (200 OK)

```

```APIDOC
## PUT /websites/ochrefulfilmentapi_apiary_io/shipments/{id}

### Description
Updates the shipment as a whole.

### Method
PUT

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/shipments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Shipment ID

### Response
#### Success Response (202 Accepted)

```

```APIDOC
## PUT /websites/ochrefulfilmentapi_apiary_io/shipments/{id}/status

### Description
Allows setting the shipment status.

### Method
PUT

### Endpoint
/websites/ochrefulfilmentapi_apiary_io/shipments/{id}/status

### Parameters
#### Path Parameters
- **id** (string) - Required - Shipment ID

### Response
#### Success Response (202 Accepted)

```

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

### Update Stock

Source: https://ochrefulfilmentapi.docs.apiary.io/

Updates stock information. This endpoint can handle multiple update requests in a single API call, up to 1000 requests.

```APIDOC
## POST /stock/update

### Description
Updates stock information for multiple items. Accepts up to 1000 update requests per call.

### Method
POST

### Endpoint
/stock/update

### Request Body
- **updates** (array of objects) - Required - A list of stock update requests.
  - **sku** (string) - Required - The SKU code to update.
  - **quantity** (integer) - Required - The new quantity.
  - **reserved_quantity** (integer) - Optional - The new reserved quantity.

### Request Example
```json
{
  "updates": [
    {
      "sku": "EXAMPLE-SKU-123",
      "quantity": 90,
      "reserved_quantity": 5
    },
    {
      "sku": "ANOTHER-SKU-456",
      "quantity": 50
    }
  ]
}
```

### Response
#### Success Response (202)
- **sku** (string) - The SKU code.
- **status** (string) - The status of the update (e.g., 'success', 'failed').
- **message** (string) - A message detailing the result of the update.

#### Response Example
```json
{
  "sku": "EXAMPLE-SKU-123",
  "status": "success",
  "message": "Stock updated successfully."
}
```
```
Tokens:
Raw