Ochre General API

https://ochreapi.docs.apiary.io
Admin
Ochre General API provides access to Ochre's services, offering endpoints for various...
Tokens:10,482
Snippets:70
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Ochre API - Style Guide

Source: https://ochreapi.docs.apiary.io/index

Outlines the style conventions for the Ochre API, including resource URL structure, URL casing, and JSON property casing.

```APIDOC
Style Guide:
  Resources: [api domain]/homepage/stores/{id}/[sub resources]
  URL Style: spinal-case (e.g., [api domain]/player/products/{id}/sub-resources)
  JSON Properties Style: camelCase
```

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

### Ochre General API Documentation

Source: https://ochreapi.docs.apiary.io/index

Provides an overview of the Ochre General API, detailing its structure and common practices. Includes sections on resource access, style guide, verbs, status codes, custom headers, and image handling.

```APIDOC
Ochre General API:
  Introduction:
    Resource access:
      - Sample call flow
    Style guide
    Verbs
    Status codes
    Custom headers
    Images
```

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

### Ochre API - Image Sizing

Source: https://ochreapi.docs.apiary.io/index

Explains the use of the 'image_size' GET parameter to retrieve images of specific dimensions from Ochre-hosted endpoints.

```APIDOC
Images:
  Endpoints returning images support the 'image_size' GET parameter.
  Available sizes:
    XL: value 'xl', width 2000
    L: value 'l', width 1000
    M: value 'm', width 500
    S: value 's', width 250
    XS: value 'xs', width 125
    XXS: value 'xxs', width 80
  Default size is 'small'.
  Example: /music/releases/96596?image_size=m returns a 500x500 image.
```

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

### Ochre API - CMS Views Profile Get

Source: https://ochreapi.docs.apiary.io/index

Allows actions on a specific view, including retrieval.

```APIDOC
GET /views/profile/{id}

URI Parameters:
  id: The ID of the view to retrieve.

This endpoint retrieves details for a specific view.
```

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

### Ochre API: Music Releases Profile Get

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile information for a specific music release using its ID.

```APIDOC
APIDOC:
  /reference/music-releases/profile/get
  GET
  Parameters:
    id (string): The ID of the release to retrieve.
  Responses:
    200 OK: Successful retrieval of release profile.
    400 Bad Request: Invalid release ID.
    401 Unauthorized: Authentication failed.
    404 Not Found: Release not found.
    500 Internal Server Error: Server error.
```

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

### Ochre API: Get Retail Order Profile

Source: https://ochreapi.docs.apiary.io/index

Retrieves the main order object for a specific retail order using its ID.

```APIDOC
Get Retail Order Profile:
  Method: GET
  Path: /orders/profile/{id}
  Parameters:
    - id: The unique identifier for the order.
  Responses:
    - 200 OK: Successfully retrieved the order profile.
    - 400 Bad Request: Invalid request parameters.
    - 401 Unauthorized: Authentication failed.
    - 404 Not Found: Order not found.
    - 500 Internal Server Error: Server error.
```

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

### Call API Endpoint

Source: https://ochreapi.docs.apiary.io/index

Illustrates how to make a GET request to an Ochre API endpoint, including the required Authorization header with a Bearer token.

```curl
curl -X GET \
  https://api.ochre.io/v1/music/artists \
  -H 'Authorization: Bearer [stored from previous ochre auth call]' \
  -H 'Host: api.ochre.io'
```

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

### Ochre API: Retail Carts Item Profile - Get

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile of a specific item within a retail cart.

```APIDOC
GET /carts/{id}/items/{item_id}

Description:
Retrieves the profile of a specific item within a retail cart.

URI Parameters:
- id: The unique identifier of the cart.
- item_id: The unique identifier of the cart item.

Responses:
- 200 OK: Successfully retrieved the item profile.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 404 Not Found: The specified cart or item does not exist.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### CMS Modules Profile Get API

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile of a specific module by its ID. Supports various HTTP status codes for success and error handling.

```APIDOC
GET /websites/ochreapi_api_io/cms-modules/profile/{id}

URI Parameters:
  id: The unique identifier for the module.

Responses:
  200 OK: Successfully retrieved the module profile.
  400 Bad Request: The request was malformed.
  401 Unauthorized: Authentication failed.
  404 Not Found: The specified module was not found.
  500 Internal Server Error: An unexpected server error occurred.
```

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

### Retail Order Item Profile Get

Source: https://ochreapi.docs.apiary.io/index

Retrieves a specific retail order item by its ID. This endpoint provides the main object details for a given order item.

```APIDOC
Retail / Order Items - Profile - Get:
  GET /retail/order-items/{id}
  Description: Gets the order item main object based on the id specified.
  URI Parameters:
    id (string): The ID of the order item.
  Responses:
    200 OK: Successful retrieval of the order item.
    400 Bad Request: Invalid request parameters.
    401 Unauthorized: Authentication failed.
    404 Not Found: The specified order item was not found.
    500 Internal Server Error: Server error.
```

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

### CMS Views Profile Get API

Source: https://ochreapi.docs.apiary.io/index

Retrieves a specific CMS view profile by its ID. Supports various HTTP status codes for success and error handling.

```APIDOC
GET /websites/ochreapi_api_io/cms-views/profile/{id}

URI Parameters:
  id: The unique identifier for the view.

Responses:
  200 OK: Successfully retrieved the view profile.
  400 Bad Request: The request was malformed.
  401 Unauthorized: Authentication failed.
  404 Not Found: The specified view was not found.
  500 Internal Server Error: An unexpected server error occurred.
```

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

### Ochre API - Get Content Media Item

Source: https://ochreapi.docs.apiary.io/index

Retrieves a specific content media item by its ID. This endpoint supports various responses including success (200 OK) and error codes (400, 401, 404, 500).

```APIDOC
GET /content-media-items/{id}

URI Parameters:
  id: The unique identifier of the content media item.

Responses:
  200 OK: Successfully retrieved the content media item.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are required or invalid.
  404 Not Found: The specified content media item could not be found.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Retail / Products API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Retail Products resources, including collection, profile, availability, and bundle items.

```APIDOC
Retail / Products:
  Collection: https://ochreapi.docs.apiary.io/#/reference/retail-products/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/retail-products/profile
  Availability: https://ochreapi.docs.apiary.io/#/reference/retail-products/availability
  Bundle items: https://ochreapi.docs.apiary.io/#/reference/retail-products/bundle-items
```

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

### Ochre API Endpoints

Source: https://ochreapi.docs.apiary.io/index

Provides base URLs for interacting with the Ochre API, including mock, production, and proxy environments.

```APIDOC
Base URLs:
  Mock: https://private-anon-0df30b9cb6-ochreapi.apiary-mock.com/v1/
  Production: https://api.ochre.io/v1/
  Proxy: https://private-anon-0df30b9cb6-ochreapi.apiary-proxy.com/v1/
```

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

### Retail Products API

Source: https://ochreapi.docs.apiary.io/index

Enables searching for products and retrieving product profiles. Details available parameters for filtering and sorting search results, along with response codes.

```APIDOC
Retail Products:
  Description: This category allows exposing all product related data. It's possible search products, get a product profile and its sub-resources.

  Collection:
    Description: Allows actions on the product collection.

    Search:
      Description: Searches for products with various filtering options.
      URI Parameters:
        store_id | filter by matching store
        catalog_id | restrict by the main catalog id
        group_id | allows grouping results by product group id
        variant_group_id | allows grouping results by variant group id
        title | filter product title (starting by)
        type | filter by type (release, track, other)
        reference_type | reference type (artist, release, track, label)
        reference_id | reference id
        from | date string with format "yyyyMMdd"
        to | date string with format "yyyyMMdd"
        format | format title, ex: "vinyl", "mp3", "cd"
        universe | universe name (music, clothing, merch)
        distribution | distribution type (physical, digital)
        variant | product variant name (mainly for clothing), ex: xs, s, l, xl, ...
        allow_preorder | show products based on their preorder permissions
        page | page number
        limit | maximum number of records per page
      Responses:
        200 OK
        400 Bad Request
        401 Unauthorized
        500 Internal Server Error

    Profile:
      Description: Gets a given product resource.

      Get:
        Description: Retrieves the profile for a specific product.
        Responses:
          200 OK
          400 Bad Request
          401 Unauthorized
          404 Not Found
          500 Internal Server Error
```

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

### Fetch Access Token

Source: https://ochreapi.docs.apiary.io/index

Demonstrates how to obtain an access token from the Ochre Auth service using a POST request with client credentials.

```curl
curl -X POST -d "client_id=[as provided]&client_secret=[as provided]&grant_type=client_credentials" https://auth.ochre.io/oauth2/token
```

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

### Retail Products Profile API

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile for a given retail product. Supports various HTTP status codes for success and errors.

```APIDOC
GET /retail-products/profile/{id}

Description:
  Retrieves the profile for a given retail product.

URI Parameters:
  id: The unique identifier for the product.

Responses:
  200 OK: Successfully retrieved product profile.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  404 Not Found: Product not found.
  500 Internal Server Error: Server error.
```

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

### Retail Products Bundle Items API

Source: https://ochreapi.docs.apiary.io/index

Lists all inner products included in a given bundle product. Supports pagination.

```APIDOC
GET /retail-products/bundle-items

Description:
  Lists all inner products included for a given bundle product.

URI Parameters:
  id: The product ID of the bundle.
  page: The page number for pagination.
  limit: The maximum number of records per page.

Responses:
  200 OK: Successfully retrieved bundle items.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: Server error.
```

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

### Retail / Orders API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Retail Orders resources, including collection, profile, and items.

```APIDOC
Retail / Orders:
  Collection: https://ochreapi.docs.apiary.io/#/reference/retail-orders/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/retail-orders/profile
  Items: https://ochreapi.docs.apiary.io/#/reference/retail-orders/items
```

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

### Retail / Stores API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Retail Stores resources, including collection and profile views.

```APIDOC
Retail / Stores:
  Collection: https://ochreapi.docs.apiary.io/#/reference/retail-stores/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/retail-stores/profile
```

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

### Music / Releases API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Music Releases resources, including collection, profile, and tracks.

```APIDOC
Music / Releases:
  Collection: https://ochreapi.docs.apiary.io/#/reference/music-releases/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/music-releases/profile
  Tracks: https://ochreapi.docs.apiary.io/#/reference/music-releases/tracks
```

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

### Ochre API: Music Releases Tracks List

Source: https://ochreapi.docs.apiary.io/index

Lists all tracks associated with a given music release, with options for pagination.

```APIDOC
APIDOC:
  /reference/music-releases/tracks/list
  GET
  Parameters:
    id (string): The ID of the release.
    artist_id (string, optional): Filter tracks by artist ID.
    page (integer, optional): Page number for pagination.
    limit (integer, optional): Maximum number of tracks per page.
  Responses:
    200 OK: Successfully listed tracks for the release.
    400 Bad Request: Invalid release ID or parameters.
    401 Unauthorized: Authentication failed.
    500 Internal Server Error: Server error.
```

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

### Retail Stores API

Source: https://ochreapi.docs.apiary.io/index

Provides endpoints for searching retail stores and retrieving individual store profiles. Includes details on URI parameters and possible HTTP responses.

```APIDOC
Retail Stores:
  Description: This category exposes the store resource. It will allow searching stores and getting the related sub-resources.

  Collection:
    Description: Allows actions on the store collection.

    Search:
      Description: Searches for stores.
      URI Parameters:
        page | page number
        limit | maximum number of records per page
      Responses:
        200 OK
        400 Bad Request
        401 Unauthorized
        500 Internal Server Error

    Profile:
      Description: Gets a store profile.

      Get:
        Description: Retrieves a specific store's profile.
        URI Parameters:
          id | The unique identifier for the store.
        Responses:
          200 OK
          400 Bad Request
          401 Unauthorized
          404 Not Found
          500 Internal Server Error
```

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

### Retail / Order Items API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Retail Order Items resources, including collection and profile views.

```APIDOC
Retail / Order Items:
  Collection: https://ochreapi.docs.apiary.io/#/reference/retail-order-items/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/retail-order-items/profile
```

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

### Ochre API: Retail Carts Items - Add

Source: https://ochreapi.docs.apiary.io/index

Enables adding items to a retail cart.

```APIDOC
POST /carts/{id}/items

Description:
Adds one or more items to a specific retail cart.

URI Parameters:
- id: The unique identifier of the cart.

Responses:
- 201 Created: The item was successfully added.
- 200 OK: The item was successfully added and the updated cart is returned.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API: Search Retail Orders

Source: https://ochreapi.docs.apiary.io/index

Searches for retail orders based on various criteria such as store IDs, user IDs, creation/update dates, and total amounts. Supports pagination.

```APIDOC
Search Retail Orders:
  Method: GET
  Path: /orders/collection/search
  Parameters:
    - store_ids: Comma-separated list of store IDs to filter by.
    - user_ids: Comma-separated list of user IDs (customer IDs) to filter by.
    - created_from: Initial date created to filter from (yyyyMMdd).
    - created_to: Limit date created (excluding, yyyyMMdd).
    - updated_from: Initial date updated to filter from (yyyyMMdd).
    - updated_to: Limit date updated (excluding, yyyyMMdd).
    - total_min: Minimum total amount to filter by.
    - total_max: Maximum total amount to filter by.
    - page: The page number for pagination (optional).
    - limit: The maximum number of records per page (optional).
  Responses:
    - 200 OK: Successfully retrieved the list of orders.
    - 400 Bad Request: Invalid request parameters.
    - 401 Unauthorized: Authentication failed.
    - 500 Internal Server Error: Server error.
```

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

### Music / Artists API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Music Artists resources, including collection, profile, releases, and tracks.

```APIDOC
Music / Artists:
  Collection: https://ochreapi.docs.apiary.io/#/reference/music-artists/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/music-artists/profile
  Releases: https://ochreapi.docs.apiary.io/#/reference/music-artists/releases
  Tracks: https://ochreapi.docs.apiary.io/#/reference/music-artists/tracks
```

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

### Retail Order Items List and Search

Source: https://ochreapi.docs.apiary.io/index

Retrieves a filterable collection of retail order items. Supports filtering by store, user, order details, creation date, and total/quantity ranges. Pagination is available via 'page' and 'limit' parameters.

```APIDOC
Retail / Order Items - Collection - Search:
  GET /retail/order-items
  Description: Allows access to a filterable order item collection. Results will be pulled from all catalogs to which the token has access to.
  URI Parameters:
    store_ids (string, optional): List of store ids split by `,`
    user_ids (string, optional): List of user ids (customer ids) split by `,`
    order_id (string, optional): Purchase order id
    order_number (string, optional): Purchase order number string
    created_from (string, optional): Initial date created to filter from (including). Format: `yyyyMMdd`
    created_to (string, optional): Limit date created (excluding). Format: `yyyyMMdd`
    total_min (number, optional): Initial value to filter from (including)
    total_max (number, optional): Limit value to filter to (including)
    quantity_min (integer, optional): Initial value to filter from (including)
    quantity_max (integer, optional): Limit value to filter to (including)
    page (integer, optional): Page number
    limit (integer, optional): Maximum number of records per page
  Responses:
    200 OK: Successful retrieval of order items.
    400 Bad Request: Invalid request parameters.
    401 Unauthorized: Authentication failed.
    500 Internal Server Error: Server error.
```

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

### Ochre API - CMS Spaces Collection Search

Source: https://ochreapi.docs.apiary.io/index

Describes how to search for CMS spaces, specifying parameters like space name, type, owner ID, and pagination.

```APIDOC
CMS / Spaces - Collection:
  Allows actions on the spaces collection.

  Search:
    URI Parameters:
      space name (starting by): Filter spaces by name.
      type: Filter by space type (artist, release, label, store, generic).
      owner_id: Filter by owner ID.
      owner_name: Filter by owner name.
      page: Page number for pagination.
      limit: Maximum number of records per page.
```

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

### Ochre API - Resource Access

Source: https://ochreapi.docs.apiary.io/index

Details on how to access Ochre API resources, requiring an access token in the Authorization header.

```APIDOC
Resource Access:
  All endpoints are secured by default and require a valid access token.
  Access tokens are issued by the Ochre Auth service: https://auth.ochre.io/oauth2/token
  Requests must include the 'Authorization' header with a 'Bearer' token.
  Authorization: Bearer [access_token]
  Access token TTL: 7200 seconds. Fetch new tokens upon expiration.
```

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

### Retail Products Availability API

Source: https://ochreapi.docs.apiary.io/index

Checks the stock and territory availability for a given product. Gathers location data from the request IP or custom headers.

```APIDOC
GET /retail-products/availability

Description:
  Checks for the given product stock and territory availability.
  Gathers location data from the request by IP or custom location headers.

Responses:
  200 OK: Successfully retrieved availability information.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  404 Not Found: Product or territory not found.
  500 Internal Server Error: Server error.
```

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

### Ochre API: Music Track Media Items

Source: https://ochreapi.docs.apiary.io/index

Lists all media items associated with a given track, with filtering by type, format, service, date range, and pagination.

```APIDOC
GET /music-tracks/{id}/media-items/list

URI Parameters:
  id: track id
  type: media item type (audio, video, image)
  format: media item format (mp3, external_id, link, embed)
  service: source service name (e.g., ochre, youtube)
  catalog_id: catalog id
  from: release date string (yyyyMMdd)
  to: release date string (yyyyMMdd)
  include_references: boolean to include references
  page: page number
  limit: maximum number of records per page

Responses:
  200 OK
  400 Bad Request
  401 Unauthorized
  500 Internal Server Error
```

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

### Music / Labels API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Music Labels resources, including collection and profile views.

```APIDOC
Music / Labels:
  Collection: https://ochreapi.docs.apiary.io/#/reference/music-labels/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/music-labels/profile
```

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

### Music / Tracks API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Music Tracks resources, including collection, profile, and media items.

```APIDOC
Music / Tracks:
  Collection: https://ochreapi.docs.apiary.io/#/reference/music-tracks/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/music-tracks/profile
  Media items: https://ochreapi.docs.apiary.io/#/reference/music-tracks/media-items
```

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

### Ochre API: Music Artists Tracks List

Source: https://ochreapi.docs.apiary.io/index

Lists tracks associated with a given artist, with options for pagination.

```APIDOC
APIDOC:
  /reference/music-artists/tracks/list
  GET
  Parameters:
    id (string): The ID of the artist.
    artist_id (string, optional): Filter tracks by artist ID (redundant if 'id' is artist ID).
    page (integer, optional): Page number for pagination.
    limit (integer, optional): Maximum number of tracks per page.
  Responses:
    200 OK: Successfully listed tracks for the artist.
    400 Bad Request: Invalid artist ID or parameters.
    401 Unauthorized: Authentication failed.
    500 Internal Server Error: Server error.
```

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

### Ochre API - Verbs

Source: https://ochreapi.docs.apiary.io/index

Defines the standard HTTP verbs used in the Ochre API and their corresponding actions.

```APIDOC
Verbs:
  POST: create
  GET: Read
  PUT: Update/Replace
  PATCH: Update/Modify
  DELETE: Delete
```

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

### Content / Media items API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Content Media items resources, including collection and profile views.

```APIDOC
Content / Media items:
  Collection: https://ochreapi.docs.apiary.io/#/reference/content-media-items/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/content-media-items/profile
```

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

### Ochre API - CMS Spaces Navigation Items List

Source: https://ochreapi.docs.apiary.io/index

Lists all navigation items for a specified CMS space. Supports pagination and filtering by group ID.

```APIDOC
GET /spaces/{id}/navigation-items

URI Parameters:
  id: space id
  page: page number
  limit: maximum number of records per page
  group_id: navigation group id

Responses:
  200 OK: Successfully listed navigation items.
```

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

### Ochre API: Content Media Items Search

Source: https://ochreapi.docs.apiary.io/index

Searches for content media items based on reference type, ID, media type, format, service, date range, and pagination.

```APIDOC
GET /content-media-items/collection/search

URI Parameters:
  reference_type: reference type (artist, release, track, product, product_group)
  reference_id: reference id
  type: media item type (audio, video, image)
  format: media item format (mp3, external_id, link, embed)
  service: source service name (e.g., ochre, youtube)
  catalog_id: catalog id
  from: release date string (yyyyMMdd)
  to: release date string (yyyyMMdd)
  include_references: boolean to include references
  page: page number
  limit: maximum number of records per page

Responses:
  200 OK
  400 Bad Request
  401 Unauthorized
  500 Internal Server Error
```

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

### Ochre API: Music Tracks Search

Source: https://ochreapi.docs.apiary.io/index

Searches for music tracks based on artist ID, release ID, and pagination parameters.

```APIDOC
GET /music-tracks/collection/search

URI Parameters:
  artist_id: artist id
  release_id: release id
  page: page number
  limit: maximum number of records per page

Responses:
  200 OK
  400 Bad Request
  401 Unauthorized
  500 Internal Server Error
```

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

### CMS / Modules API

Source: https://ochreapi.docs.apiary.io/index

Provides access to CMS Modules resources, including collection, profile, and content item details.

```APIDOC
CMS / Modules:
  Collection: https://ochreapi.docs.apiary.io/#/reference/cms-modules/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/cms-modules/profile
  Content items: https://ochreapi.docs.apiary.io/#/reference/cms-modules/content-items
```

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

### CMS / Spaces API

Source: https://ochreapi.docs.apiary.io/index

Provides access to CMS Spaces resources, including collection and profile views.

```APIDOC
CMS / Spaces:
  Collection: https://ochreapi.docs.apiary.io/#/reference/cms-spaces/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/cms-spaces/profile
  Navigation items: https://ochreapi.docs.apiary.io/#/reference/cms-spaces/navigation-items
  Views: https://ochreapi.docs.apiary.io/#/reference/cms-spaces/views
```

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

### Music Labels Collection Search

Source: https://ochreapi.docs.apiary.io/index

Allows searching and retrieval of music label data. Supports pagination through 'page' and 'limit' parameters.

```APIDOC
Music / Labels - Collection - Search:
  GET /music/labels
  Description: Allows action on the label collection.
  URI Parameters:
    page (integer, optional): Page number
    limit (integer, optional): Maximum number of records per page
  Responses:
    200 OK: Successful retrieval of music labels.
    400 Bad Request: Invalid request parameters.
    401 Unauthorized: Authentication failed.
    500 Internal Server Error: Server error.
```

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

### Ochre API - CMS Spaces Views List

Source: https://ochreapi.docs.apiary.io/index

Lists all views belonging to a given space, with support for various filtering parameters.

```APIDOC
GET /spaces/{id}/views

URI Parameters:
  id: space id
  type: view type (artist, release, homepage, article)
  reference_type: reference type (artist, release, label, store)
  reference_id: reference id
  slug: view slug
  title: view title (starting by)
  page: page number
  limit: maximum number of records per page

Responses:
  200 OK: Successfully listed views.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: Server error.
```

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

### Ochre General API Documentation

Source: https://ochreapi.docs.apiary.io/traffic

Provides access to the Ochre General API documentation, including traffic inspection tools and the ability to create new API projects.

```APIDOC
Ochre General API:
  Description: Documentation for the Ochre General API.
  Links:
    - Documentation: https://ochreapi.docs.apiary.io
    - Inspector: https://ochreapi.docs.apiary.io/traffic
  Actions:
    - Create New API Project: https://ochreapi.docs.apiary.io/create-api
  Mock Server:
    Listening at: https://private-anon-0df30b9cb6-ochreapi.apiary-mock.com
  Features:
    - Show Missed Request: On/Off toggle for displaying missed requests.
```

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

### Music Artists Releases List API

Source: https://ochreapi.docs.apiary.io/index

Lists all releases associated with a given artist, with options for filtering.

```APIDOC
GET /reference/music-artists/releases/list

Description: Lists releases from the given artist.

URI Parameters:
  id: The unique identifier of the artist.
  title: Release title (starting by).
  label_id: Filter by label ID.
  catalog_id: Filter by catalog ID.
  from: Release date string with format "yyyyMMdd".
  to: Release date string with format "yyyyMMdd".
  page: Page number for pagination.
  limit: Maximum number of records per page.

Responses:
  200 OK: Successfully listed the artist's releases.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are missing or invalid.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API: Music Releases Collection Search

Source: https://ochreapi.docs.apiary.io/index

Allows searching for music releases based on various parameters like title, artist ID, artist name, label ID, catalog ID, date range, page, and limit.

```APIDOC
APIDOC:
  /reference/music-releases/collection/search
  GET
  Parameters:
    title (string, optional): release title (starting by)
    artist_id (string, optional): artist id
    artist_name (string, optional): artist name (starting by)
    label_id (string, optional): label id
    catalog_id (string, optional): catalog id
    from (string, optional): release date string with format "yyyyMMdd"
    to (string, optional): release date string with format "yyyyMMdd"
    page (integer, optional): page number
    limit (integer, optional): maximum number of records per page
  Responses:
    200 OK: Successful search.
    400 Bad Request: Invalid request parameters.
    401 Unauthorized: Authentication failed.
    500 Internal Server Error: Server error.
```

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

### Ochre API: Retail Carts Profile

Source: https://ochreapi.docs.apiary.io/index

Provides endpoints for retrieving the profile of a retail cart.

```APIDOC
GET /carts/{id}

Description:
Retrieves the profile of a specific retail cart.

URI Parameters:
- id: The unique identifier of the cart.

Responses:
- 200 OK: Successfully retrieved the cart profile.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 404 Not Found: The specified cart does not exist.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Retail Carts Collection API

Source: https://ochreapi.docs.apiary.io/index

Manages the cart collection, including creating new carts.

```APIDOC
POST /retail-carts

Description:
  Creates a new cart resource.

URI Parameters:
  store_id: The ID of the store for which to create the cart.

Responses:
  201 Created: Cart successfully created.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: Server error.
```

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

### CMS / Views API

Source: https://ochreapi.docs.apiary.io/index

Provides access to CMS Views resources, including collection, profile, and module details.

```APIDOC
CMS / Views:
  Collection: https://ochreapi.docs.apiary.io/#/reference/cms-views/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/cms-views/profile
  Modules: https://ochreapi.docs.apiary.io/#/reference/cms-views/modules
```

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

### Retail / Carts API

Source: https://ochreapi.docs.apiary.io/index

Provides access to Retail Carts resources, including collection, profile, items, item profiles, and vouchers.

```APIDOC
Retail / Carts:
  Collection: https://ochreapi.docs.apiary.io/#/reference/retail-carts/collection
  Profile: https://ochreapi.docs.apiary.io/#/reference/retail-carts/profile
  Items: https://ochreapi.docs.apiary.io/#/reference/retail-carts/items
  Item profile: https://ochreapi.docs.apiary.io/#/reference/retail-carts/item-profile
  Vouchers: https://ochreapi.docs.apiary.io/#/reference/retail-carts/vouchers
```

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

### Ochre API: List Vouchers in Cart

Source: https://ochreapi.docs.apiary.io/index

Retrieves a list of vouchers associated with a specific retail cart. Supports pagination.

```APIDOC
List Vouchers in Cart:
  Method: GET
  Path: /carts/{cart_id}/vouchers
  Parameters:
    - cart_id: The unique identifier for the cart.
    - page: The page number for pagination (optional).
    - limit: The maximum number of records per page (optional).
  Responses:
    - 200 OK: Successfully retrieved the list of vouchers.
    - 400 Bad Request: Invalid request parameters.
    - 401 Unauthorized: Authentication failed.
    - 500 Internal Server Error: Server error.
```

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

### Ochre API - CMS Spaces Profile

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile information for a given CMS space. Supports various HTTP status codes for success and error scenarios.

```APIDOC
GET /spaces/{id}

URI Parameters:
  id: space id

Responses:
  200 OK: Successful retrieval of space profile.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  404 Not Found: Space not found.
  500 Internal Server Error: Server error.
```

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

### CMS Modules Collection Search API

Source: https://ochreapi.docs.apiary.io/index

Searches for modules based on view ID, title, and type, with pagination support. Returns a collection of modules matching the criteria. Supports various HTTP status codes.

```APIDOC
GET /websites/ochreapi_api_io/cms-modules/collection/search

URI Parameters:
  view_id: The ID of the view to search modules within.
  page: The page number for pagination.
  limit: The maximum number of records per page.

Query Parameters:
  title: Filters modules by title (partial match).
  type: Filters modules by type. Available types: `product-block`, `list`, `text`, `image`, `video`, `banner`, `header`.

Responses:
  200 OK: Successfully found modules.
  400 Bad Request: The request was malformed.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: An unexpected server error occurred.
```

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

### Music Artists Tracks List API

Source: https://ochreapi.docs.apiary.io/index

Lists all tracks associated with a given artist.

```APIDOC
GET /reference/music-artists/tracks/list

Description: Lists tracks from the given artist.

URI Parameters:
  id: The unique identifier of the artist.

Responses:
  200 OK: Successfully listed the artist's tracks.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are missing or invalid.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### CMS Views Modules List API

Source: https://ochreapi.docs.apiary.io/index

Lists all modules associated with a given view, with options for filtering and pagination. Supports various HTTP status codes.

```APIDOC
GET /websites/ochreapi_api_io/cms-views/modules/list

URI Parameters:
  id: The ID of the view to list modules for.
  page: The page number for pagination.
  limit: The maximum number of records per page.

Query Parameters:
  title: Filters modules by title (partial match).
  type: Filters modules by type. Available types: `product-block`, `list`, `text`, `image`, `video`, `banner`, `header`.

Responses:
  200 OK: Successfully listed modules.
  400 Bad Request: The request was malformed.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: An unexpected server error occurred.
```

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

### Ochre API - Custom Headers

Source: https://ochreapi.docs.apiary.io/index

Details custom headers required for passing location-related information, such as client IP, currency, and country code.

```APIDOC
Custom Headers:
  X-Client-IP: Client's IP address.
  X-Client-Currency: ISO 4217 currency code.
  X-Client-Country-Code2: ISO Alpha-2 country code.
```

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

### CMS Modules Content Items List API

Source: https://ochreapi.docs.apiary.io/index

Lists content items associated with a specific module, with pagination support. Supports various HTTP status codes.

```APIDOC
GET /websites/ochreapi_api_io/cms-modules/content-items/list/{id}

URI Parameters:
  id: The ID of the module to list content items for.
  page: The page number for pagination.
  limit: The maximum number of records per page.

Responses:
  200 OK: Successfully listed content items.
  400 Bad Request: The request was malformed.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: An unexpected server error occurred.
```

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

### Ochre API: List Order Items

Source: https://ochreapi.docs.apiary.io/index

Retrieves the collection of items associated with a specific retail order ID.

```APIDOC
List Order Items:
  Method: GET
  Path: /orders/{order_id}/items
  Parameters:
    - order_id: The unique identifier for the order.
  Responses:
    - 200 OK: Successfully retrieved the list of order items.
    - 400 Bad Request: Invalid request parameters.
    - 401 Unauthorized: Authentication failed.
    - 404 Not Found: Order not found.
    - 500 Internal Server Error: Server error.
```

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

### Ochre API: Retail Carts Items - List

Source: https://ochreapi.docs.apiary.io/index

Allows listing items within a specific retail cart.

```APIDOC
GET /carts/{id}/items

Description:
Retrieves a list of items associated with a specific retail cart.

URI Parameters:
- id: The unique identifier of the cart.
- page: The page number for pagination.
- limit: The maximum number of records to return per page.

Responses:
- 200 OK: Successfully retrieved the list of items.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API: Music Track Profile

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile for a given music track using its ID.

```APIDOC
GET /music-tracks/profile/{id}

URI Parameters:
  id: The ID of the track

Responses:
  200 OK
  400 Bad Request
  401 Unauthorized
  404 Not Found
  500 Internal Server Error
```

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

### Music Artists Profile API

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile information for a specific artist using their ID.

```APIDOC
GET /reference/music-artists/profile/get

Description: Gets an artist profile.

URI Parameters:
  id: The unique identifier of the artist.

Responses:
  200 OK: Successfully retrieved the artist profile.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are missing or invalid.
  404 Not Found: The specified artist ID does not exist.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API - Status Codes

Source: https://ochreapi.docs.apiary.io/index

Specifies that API actions should follow standard HTTP status codes as defined in RFC7231.

```APIDOC
Status Codes:
  Follow RFC7231 for expected status codes for each action.
```

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

### Music Labels Profile API

Source: https://ochreapi.docs.apiary.io/index

Retrieves the profile information for a specific music label using its ID.

```APIDOC
GET /reference/music-labels/profile

Description: Gets a label profile.

URI Parameters:
  id: The unique identifier of the music label.

Responses:
  200 OK: Successfully retrieved the label profile.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are missing or invalid.
  404 Not Found: The specified label ID does not exist.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Music Artists Collection Search API

Source: https://ochreapi.docs.apiary.io/index

Searches for artists within the collection based on various criteria.

```APIDOC
GET /reference/music-artists/collection/search

Description: Allows actions on the artist collection.

URI Parameters:
  name: Artist name (contains criteria).
  active: Artist status (true/false).
  catalog_id: Main catalog ID.
  page: Page number for pagination.
  limit: Maximum number of records per page.

Responses:
  200 OK: Successfully found artists matching the criteria.
  400 Bad Request: The request was malformed or invalid.
  401 Unauthorized: Authentication credentials are missing or invalid.
  500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Retail Carts Profile API

Source: https://ochreapi.docs.apiary.io/index

Retrieves a specific cart profile, including estimated postage costs.

```APIDOC
GET /retail-carts/{cart_id}

Description:
  Gets a specific cart profile. Carts will include an estimated postage cost associated.

URI Parameters:
  cart_id: The ID of the cart to retrieve.

Responses:
  200 OK: Successfully retrieved cart profile.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  404 Not Found: Cart not found.
  500 Internal Server Error: Server error.
```

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

### Ochre API - CMS Views Collection Search

Source: https://ochreapi.docs.apiary.io/index

Searches the view collection within a space, allowing filtering by various view and reference attributes.

```APIDOC
GET /views/collection/search

URI Parameters:
  space_id: space id
  type: view type (artist, release, homepage, article)
  reference_type: reference type (artist, release, label, store)
  reference_id: reference id
  slug: view slug
  title: view title (starting by)
  page: page number
  limit: maximum number of records per page

Responses:
  200 OK: Successfully searched views.
  400 Bad Request: Invalid request parameters.
  401 Unauthorized: Authentication failed.
  500 Internal Server Error: Server error.
```

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

### Ochre API: Retail Carts Item Profile - Update

Source: https://ochreapi.docs.apiary.io/index

Updates a specific item within a retail cart. Only quantities can be updated.

```APIDOC
PUT /carts/{id}/items/{item_id}

Description:
Updates the quantity of a specific item within a retail cart.

URI Parameters:
- id: The unique identifier of the cart.
- item_id: The unique identifier of the cart item.

Responses:
- 202 Accepted: The update request has been accepted.
- 200 OK: The item was successfully updated.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 404 Not Found: The specified cart or item does not exist.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API: Retail Carts Item Profile - Delete

Source: https://ochreapi.docs.apiary.io/index

Allows deletion of a specific item from a retail cart.

```APIDOC
DELETE /carts/{id}/items/{item_id}

Description:
Removes a specific item from a retail cart.

URI Parameters:
- id: The unique identifier of the cart.
- item_id: The unique identifier of the cart item.

Responses:
- 200 OK: The item was successfully removed.
- 400 Bad Request: The request was malformed or invalid.
- 401 Unauthorized: Authentication credentials are missing or invalid.
- 404 Not Found: The specified cart or item does not exist.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

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

### Ochre API: Delete Cart Item

Source: https://ochreapi.docs.apiary.io/index

Deletes a specific item from a retail cart. Requires the cart ID and the item ID.

```APIDOC
Delete Cart Item:
  Method: DELETE
  Path: /carts/{cart_id}/items/{item_id}
  Parameters:
    - cart_id: The unique identifier for the cart.
    - item_id: The unique identifier for the item within the cart.
  Responses:
    - 202 Accepted: Item successfully deleted.
    - 400 Bad Request: Invalid request parameters.
    - 401 Unauthorized: Authentication failed.
    - 404 Not Found: Cart or item not found.
    - 500 Internal Server Error: Server error.
```
Tokens:
Raw