Docs
Management API
Price Lists Assignments

Price Lists Assignments

Get Price List Assignments

GET /pricelists/assignments

Request

Fetches an array of Price List Assignments matching a particular Customer Group and Price List and Channel.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • id in query - integer

    The ID of the Price List Assignment.

  • price_list_id in query - integer

    The ID of the Price List.

  • customer_group_id in query - integer

    The ID of the Customer Group.

  • channel_id in query - integer

    The ID of the Channel.

  • id:in in query - array

    Filter items by a comma-separated list of IDs.

    Type: array[integer]

  • customer_group_id:in in query - array

    Filter items by a comma-separated list of customer group IDs.

    Type: array[integer]

  • price_list_id:in in query - array

    Filter items by a comma-separated list of price list IDs.

    Type: array[integer]

  • channel_id:in in query - array

    Filter items by a comma-separated list of channel IDs.

    Type: array[integer]

  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list of products.

example

Response

An array of price list assignments and metadata.

Body

object | application/json

Array of the price list assignments matching the filter. The response is paginated.

  • data
    array[object]

  • meta
    object

    Data related the response, including pagination and collection totals.

example

Create Price List Assignments

POST /pricelists/assignments

Request

Creates a batch of Price List Assignments. Note: The batch limit for Price List Assignments is 25.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json

Batch of price list assignments.

  • price_list_id
    integer
    required

    Price list ID for assignment.

    Example: 1

  • customer_group_id
    integer

    Customer group ID for assignment.

    Example: 2

  • channel_id
    integer

    Channel ID for assignment

    Example: 1

example

Response

OK

Body

object | application/json

Empty object for Success case for Batch API.

  • data
    object

    Example: {}

  • meta
    object

    Example: {}

example

Delete Price List Assignments

DELETE /pricelists/assignments

Request

Deletes one or more Price List Assignments objects from BigCommerce using a query parameter. You must use at least one query parameter.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id in query - integer

    The ID of the Price List Assignment.

  • price_list_id in query - integer

    The ID of the Price List.

  • customer_group_id in query - integer

    The ID of the Customer Group.

  • channel_id in query - integer

    The ID of the Channel.

  • channel_id:in in query - array

    Filter results by a comma-separated list of channel IDs.

    Type: array[integer]

example

Response

No Content.

Upsert Price List Assignment

PUT /pricelists/{price_list_id}/assignments

Request

Upsert a single Price List Assignment for a Price List. Note:

  • Supports up to 25 simultaneous PUT requests. Running more than the allowed number of requests concurrently on the same store will result in a 429 status error and your additional requests will fail.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • price_list_id in path - integer
    required

    The ID of the Price List requested.

  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • customer_group_id
    integer
    required

    Customer group ID for assignment.

    Example: 2

  • channel_id
    integer
    required

    Channel ID for assignment

    Example: 1

example

Response

A price list assignment.

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?