{"openapi":"3.1.0","info":{"title":"Admin Management: Price Lists","version":"1.0.0"},"paths":{"/stores/{store_hash}/v3/pricelists":{"get":{"operationId":"getPriceLists","summary":"List Price Lists","description":"Returns a list of *Price Lists*. Optional parameters can be passed in.","tags":["priceLists"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter items by name.\n","required":false,"schema":{"type":"string"}},{"name":"date_created","in":"query","description":"Filter items by date_created.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified","in":"query","description":"Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15`","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Specifies the page number in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit.","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.","required":false,"schema":{"type":"string"}},{"name":"id:in","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"name:like","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_created:max","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_created:min","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_modified:max","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_modified:min","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists_getPriceLists_Response_200"}}}}}},"post":{"operationId":"createPriceList","summary":"Create Price List","description":"Creates a *Price List*.\n\n**Required Fields**\n* name","tags":["priceLists"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists_createPriceList_Response_200"}}}},"409":{"description":"`Price List` conflicts with another Price List. This is the result of duplicate unique values, such as `name`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePriceListRequestConflictError"}}}},"422":{"description":"`Price List` is not valid. This is the result of missing required fields, or of invalid data. See the response for more details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePriceListRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"Creates a Price List. ","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the Price List. Required in a POST request."},"active":{"type":"boolean","description":"Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Fallback price lists to assign on creation. Maximum one item.\n"}},"required":["name"]}}}}},"delete":{"operationId":"deletePriceLists","summary":"Delete All Price Lists","description":"Deletes a *Price List*. All associated price records are also removed. Optional parameters can be passed in.","tags":["priceLists"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"id:in","in":"query","description":"Filter by ID. Accepts multiple comma-separated values.\n","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"name","in":"query","description":"Filter items by name.\n","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"`204 No Content`. The action has been performed and no further information will be supplied. `null` is returned.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"503":{"description":"Service temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}}}},"/stores/{store_hash}/v3/pricelists/{price_list_id}":{"get":{"operationId":"getPriceList","summary":"Get Price List","description":" Returns a single *Price List*.","tags":["priceLists"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists_getPriceList_Response_200"}}}}}},"put":{"operationId":"updatePriceList","summary":"Update Price List","description":"Updates a *Price List*.","tags":["priceLists"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists_updatePriceList_Response_200"}}}},"404":{"description":"The resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePriceListRequestNotFoundError"}}}},"409":{"description":"`Price List` was in conflict with another Price List. This is the result of duplicate unique values, such as `name`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePriceListRequestConflictError"}}}},"422":{"description":"`Price List` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePriceListRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"Update a PriceList","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the Price List. Required in a POST request."},"active":{"type":"boolean","description":"Whether or not this `Price List` and its prices are active. Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Controls the fallback price lists assigned to this price list. Behavior depends on the value provided:\n\n- **Omitted**: no change to existing layers.\n- **Empty array** (`[]`): removes all layers.\n- **Array with items**: replaces the current layers with the provided list.\n\nMaximum one item.\n"}},"required":["name"]}}}}},"delete":{"operationId":"deletePriceList","summary":"Delete Price List","description":"Deletes a *Price List*. All associated price records are also removed.\n**Limits**\n* Limit of 1 concurrent request.","tags":["priceLists"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"Action has been enacted and no further information is to be supplied. `null` is returned.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"503":{"description":"Service temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}}}},"/stores/{store_hash}/v3/pricelists/assignments":{"get":{"operationId":"getListOfPriceListAssignments","summary":"Get Price List Assignments","description":"Fetches an array of `Price List Assignments` matching a particular Customer Group and Price List and Channel.","tags":["priceListsAssignments"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"The ID of the `Price List Assignment`.","required":false,"schema":{"type":"integer"}},{"name":"price_list_id","in":"query","description":"The ID of the `Price List`.","required":false,"schema":{"type":"integer"}},{"name":"customer_group_id","in":"query","description":"The ID of the `Customer Group`.","required":false,"schema":{"type":"integer"}},{"name":"channel_id","in":"query","description":"The ID of the `Channel`.","required":false,"schema":{"type":"integer"}},{"name":"id:in","in":"query","description":"Filter items by a comma-separated list of IDs.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"customer_group_id:in","in":"query","description":"Filter items by a comma-separated list of customer group IDs.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"price_list_id:in","in":"query","description":"Filter items by a comma-separated list of price list IDs.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"channel_id:in","in":"query","description":"Filter items by a comma-separated list of channel IDs.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"page","in":"query","description":"Specifies the page number in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit.","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"An array of price list assignments and metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentsForGetResponse"}}}}}},"post":{"operationId":"createPriceListAssignments","summary":"Create Price List Assignments","description":"Creates a batch of `Price List Assignments`. \n**Note:** The batch limit for `Price List Assignments` is 25.","tags":["priceListsAssignments"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Assignments_createPriceListAssignments_Response_200"}}}},"422":{"description":"Error response. Includes the errors for each reference ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceListAssignmentsBatchErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBatchPriceListAssignmentsRequest"}}}}},"delete":{"operationId":"deletePriceListAssignments","summary":"Delete Price List Assignments","description":"Deletes one or more `Price List Assignments` objects from BigCommerce using a query parameter. You must use at least one query parameter.\n\n**Note:** Although each of the query parameters below is individually optional, you must provide at least one of them to identify which assignments to delete.","tags":["priceListsAssignments"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"The ID of the `Price List Assignment`.","required":false,"schema":{"type":"integer"}},{"name":"price_list_id","in":"query","description":"The ID of the `Price List`.","required":false,"schema":{"type":"integer"}},{"name":"customer_group_id","in":"query","description":"The ID of the `Customer Group`.","required":false,"schema":{"type":"integer"}},{"name":"channel_id","in":"query","description":"The ID of the `Channel`.","required":false,"schema":{"type":"integer"}},{"name":"channel_id:in","in":"query","description":"Filter results by a comma-separated list of channel IDs.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"No Content.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/stores/{store_hash}/v3/pricelists/{price_list_id}/assignments":{"put":{"operationId":"upsertPriceListAssignment","summary":"Upsert Price List Assignment","description":"Upsert a single `Price List Assignment` for a `Price List`.\n**Note:**\n* 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.        ","tags":["priceListsAssignments"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"A price list assignment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentForPutResponse"}}}},"404":{"description":"A matching customer group or channel wasnʼt found, so no assignment is created or returned.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentForPutRequest"}}}}}},"/stores/{store_hash}/v3/pricelists/records":{"post":{"operationId":"createPriceListsRecords","summary":"Create Batch of Price Lists Records","description":"Creates a batch of `Price Lists Records`; may include price list records from more than one price list. Concurrency limit of 10, batch size of 100. Use `PUT` instead to update records that already exist.\n\nPer-item validation failures — items referencing an unknown price list, unresolved `variant_id` or `sku`, items missing `price`, and items that duplicate another item in the same request — are rejected individually; the remaining valid items are saved, and `meta.saved_records` reflects the saved count.\n\nIf any otherwise-valid item collides with an existing price record (same `price_list_id` + variant + `currency`), the entire batch is rolled back. `meta.saved_records` returns `0`, and the response identifies both the conflicting items and the items that would have been saved so you can fix the conflicts and resend the rest. See the `422` response for details.","tags":["priceListsRecords"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success response for batch POST of `Price List Records`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessBatchResponse"}}}},"422":{"description":"Error response for batch POST of `Price List Records`. Returned in two cases:\n\n* **Partial create** — one or more items failed per-item validation (unknown price list, unresolved variant or SKU, missing price, duplicate item in batch). The remaining valid items were saved; `meta.saved_records` reflects the saved count.\n* **Atomic rollback on conflict** — a database-level uniqueness conflict (an existing record with the same `price_list_id` + variant + `currency`) caused the entire batch to be rolled back. `meta.saved_records` returns `0`. Each conflicting item is reported with a `uid` error of `\"A price record with the same price list, variant, and currency already exists.\"`; each item that would have been saved but was rolled back with the batch is reported with a `uid` error of `\"Batch rejected, fix other errors and retry.\"` so you can identify the rows to resend after fixing the conflicts.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRecordBatchErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PriceRecordBatchItem"}}}}}},"put":{"operationId":"upsertPriceListsRecords","summary":"Create or Update Batch of Price Lists Records","description":"Creates or updates a batch of `Price Lists Records`; may include price list records from more than one price list. Concurrency limit of 1. It is advised to use POST to get better performance when creating price records.\n\n<Note>\n  Each request must include `price_list_id` and `currency`, plus either `variant_id` or `sku` to identify the variant.\n</Note>","tags":["priceListsRecords"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success response for batch PUT of `Price List Records`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessBatchResponse"}}}},"422":{"description":"Error response for batch PUT of `Price Records`.  May include errors during partial update in non-strict mode.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceRecordBatchErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PriceRecordBatchItem"}}}}}}},"/stores/{store_hash}/v3/pricelists/{price_list_id}/records":{"get":{"operationId":"getPriceListRecords","summary":"List Price List Records","description":"Returns a list of *Price List Records* associated with a *Price List*.\n\n**Notes**\n* Supports up to 10 simultaneous GET 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.\n* Store Pricelist Records data to reduce the number of calls and maximize performance.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"variant_id:in","in":"query","description":"A comma-separated list of IDs for one or more variants for which prices were requested.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"product_id:in","in":"query","description":"A comma-separated list of IDs for one or more products for which prices were requested.\n","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"currency","in":"query","description":"Filter items by currency.\n","required":false,"schema":{"type":"string","format":"ISO-4217"}},{"name":"page","in":"query","description":"Specifies the page number in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit.","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.\n","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetParametersIncludeSchemaItems"}}},{"name":"price","in":"query","description":"Filter items by price.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"sale_price","in":"query","description":"Filter items by sale_price.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"retail_price","in":"query","description":"Filter items by retail_price.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"map_price","in":"query","description":"Filter items by map_price.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"calculated_price","in":"query","description":"Filter items by calculated_price.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"date_created","in":"query","description":"Filter items by date_created.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_modified","in":"query","description":"Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2022-06-15`","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sku","in":"query","description":"Filter items by SKU.\n","required":false,"schema":{"type":"string"}},{"name":"sku:in","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"currency:in","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"price:max","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"price:min","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"sale_price:max","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"sale_price:min","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"retail_price:max","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"retail_price:min","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"map_price:max","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"map_price:min","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"calculated_price:max","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"calculated_price:min","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"date_created:max","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_created:min","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_modified:max","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_modified:min","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_getPriceListRecords_Response_200"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"createPriceListRecords","summary":"Create Price List Records","description":"Creates *Price List Records*. \n\n**Required Fields**\n* currency\n* one of `variant_id` or `sku`\n\n**Notes**\n* Batch requests support up to 100 items per request.\n* Up to 10 concurrent batch create requests are supported with this API. Running more than the allowed concurrent requests in parallel on the **same store** will cause a `429` error, and your additional requests will fail. You are encouraged to run requests sequentially with as many records per request as possible to maximize performance.\n* When creating a product with variants, or multiple SKUs, don't include records for the parent product SKU.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success response for batch POST of `Price List Records`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_createPriceListRecords_Response_200"}}}},"422":{"description":"Error response for batch POST of `Price List Records`. May include errors during partial create in non-strict mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePriceListRecordsRequestUnprocessableEntityError"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItems"}}}}}},"put":{"operationId":"upsertPriceListRecords","summary":"Upsert Price List Records","description":"Creates or updates *Price List Records*. \n\n**Required Fields**\n* currency\n\n**Notes**\n* Batch requests support up to 1,000 items per request.\n* Up to 2 concurrent batch upsert requests are supported with this API. Running more than the allowed concurrent requests in parallel on the **same store** will cause a `429` error, and your additional requests will fail. You are encouraged to run requests sequentially with as many records per request as possible to maximize performance.\n* When updating a product with variants, or multiple SKUs, don't include records for the parent product SKU.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success response for batch PUT requests of Price Records.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_upsertPriceListRecords_Response_200"}}}},"422":{"description":"Error response for batch PUT of `Price Records`. May include errors during partial update in non-strict mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPriceListRecordsRequestUnprocessableEntityError"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItems"}}}}}},"delete":{"operationId":"deletePriceListRecords","summary":"Delete Price List Record","description":"Deletes a *Price List Record*. Deleting the records does not delete the Price List. Optional parameters can be passed in.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"The 3-letter currency code with which this set of prices is associated.","required":false,"schema":{"type":"string"}},{"name":"variant_id:in","in":"query","description":"A comma-separated list of IDs for one or more variants for which prices exist.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sku:in","in":"query","description":"A comma-separated list of SKUs for one or more variants for which prices exist.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"503":{"description":"Service temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}}}},"/stores/{store_hash}/v3/pricelists/{price_list_id}/records/{variant_id}":{"get":{"operationId":"getPriceListRecordsByVariantId","summary":"List Price Records by Variant","description":"Returns *Price List Records* using the variant ID. Will also contain currency records.\n\n**Notes**\n* Supports up to 40 simultaneous GET 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.\n* Store Pricelist Records data to reduce the number of calls and maximize performance.\n","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"variant_id","in":"path","description":"ID of the variant on a product, or on an associated Price List Record.\n","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.\n","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetParametersIncludeSchemaItems"}}},{"name":"page","in":"query","description":"Specifies the page number in a limited (paginated) list of products.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Controls the number of items per page in a limited (paginated) list of products. If you provide only a limit, the API returns both paginations while applying that limit.","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_getPriceListRecordsByVariantId_Response_200"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/stores/{store_hash}/v3/pricelists/{price_list_id}/records/{variant_id}/{currency_code}":{"get":{"operationId":"getPriceListRecord","summary":"Get Price Record by Currency Code","description":"Returns a *Price List Record* using the currency code. You can use optional parameters.\n**Notes**\n* Supports up to 50 simultaneous GET 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.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"variant_id","in":"path","description":"ID of the variant on a product, or on an associated Price List Record.\n","required":true,"schema":{"type":"integer"}},{"name":"currency_code","in":"path","description":"The currency code associated with the price record being acted upon.\n","required":true,"schema":{"type":"string","format":"ISO-4217"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored.\n","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetParametersIncludeSchemaItems"}}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_getPriceListRecord_Response_200"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"setPriceListRecord","summary":"Set Price List Record by Currency Code","description":"Creates or updates a *Price List Record* using the currency code.\n**Notes**\n* Supports up to 40 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.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"variant_id","in":"path","description":"ID of the variant on a product, or on an associated Price List Record.\n","required":true,"schema":{"type":"integer"}},{"name":"currency_code","in":"path","description":"The currency code associated with the price record being acted upon.\n","required":true,"schema":{"type":"string","format":"ISO-4217"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price Lists Records_setPriceListRecord_Response_200"}}}},"404":{"description":"The resource was not found.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPriceListRecordRequestNotFoundError"}}}},"409":{"description":"`Price Record` was in conflict with another price record. This is the result of duplicate unique values.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPriceListRecordRequestConflictError"}}}},"422":{"description":"`Price Record` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPriceListRecordRequestUnprocessableEntityError"}}}},"429":{"description":"Allowed number of requests exceeded.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Common Price Record properties.","content":{"application/json":{"schema":{"type":"object","properties":{"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product.  If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItems"}}}}}}}},"delete":{"operationId":"deletePriceListRecord","summary":"Delete Price Record by Currency Code","description":"Deletes a *Price List Record* using the currency code.\n**Note:**\n* Supports up to 25 simultaneous DELETE 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.","tags":["priceListsRecords"],"parameters":[{"name":"price_list_id","in":"path","description":"The ID of the `Price List` requested.\n","required":true,"schema":{"type":"integer"}},{"name":"variant_id","in":"path","description":"ID of the variant on a product, or on an associated Price List Record.\n","required":true,"schema":{"type":"integer"}},{"name":"currency_code","in":"path","description":"The currency code associated with the price record being acted upon.\n","required":true,"schema":{"type":"string","format":"ISO-4217"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"503":{"description":"Service temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"LayerItem":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"The ID of the fallback price list."}},"description":"A fallback price list layer.","title":"LayerItem"},"PricelistsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numeric ID of the `Price List`; this number increments sequentially.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"name":{"type":"string","description":"The unique name of the Price List. Required in a POST request."},"active":{"type":"boolean","description":"Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Fallback price lists evaluated in order when a price record is not found in this price list. Maximum one layer. Inactive layers are skipped during price resolution but remain assigned.\n"}},"required":["name"],"description":"Specifies the Common Price List properties.","title":"PricelistsGetResponsesContentApplicationJsonSchemaDataItems"},"PricelistsGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items in the result set.\n"},"count":{"type":"integer","description":"Total number of items in the collection response.\n"},"per_page":{"type":"integer","description":"The amount of items returned in the collection per page, controlled by the limit parameter.\n"},"current_page":{"type":"integer","description":"The page you are currently on within the collection.\n"},"total_pages":{"type":"integer","description":"The total number of pages in the collection.\n"}},"description":"Data related to the response, including pagination and collection totals.","title":"PricelistsGetResponsesContentApplicationJsonSchemaMetaPagination"},"PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks":{"type":"object","properties":{"previous":{"type":"string","description":"Link to the previous page returned in the response."},"current":{"type":"string","description":"Link to the current page returned in the response."},"next":{"type":"string","description":"Link to the next page returned in the response."}},"description":"Pagination links for the previous and next parts of the whole collection.","title":"PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks"},"PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPagination":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items in the collection response."},"per_page":{"type":"integer","description":"The number of items that can be returned per page, determined by the limit parameter—whether explicitly set, defaulted, or capped at the maximum limit."},"start_cursor":{"type":"string","description":"A string representing the starting point of the current page in the collection."},"end_cursor":{"type":"string","description":"A string representing the ending point of the current page in the collection."},"links":{"$ref":"#/components/schemas/PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks","description":"Pagination links for the previous and next parts of the whole collection."}},"title":"PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPagination"},"PricelistsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PricelistsGetResponsesContentApplicationJsonSchemaMetaPagination","description":"Data related to the response, including pagination and collection totals."},"cursor_pagination":{"$ref":"#/components/schemas/PricelistsGetResponsesContentApplicationJsonSchemaMetaCursorPagination"}},"description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'","title":"PricelistsGetResponsesContentApplicationJsonSchemaMeta"},"Price Lists_getPriceLists_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/PricelistsGetResponsesContentApplicationJsonSchemaMeta","description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'"}},"description":"Get All PriceLists.","title":"Price Lists_getPriceLists_Response_200"},"PricelistsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numeric ID of the `Price List`; this number increments sequentially.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"name":{"type":"string","description":"The unique name of the Price List. Required in a POST request."},"active":{"type":"boolean","description":"Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Fallback price lists evaluated in order when a price record is not found in this price list. Maximum one layer. Inactive layers are skipped during price resolution but remain assigned.\n"}},"required":["name"],"description":"Specifies the Common Price List properties.","title":"PricelistsPostResponsesContentApplicationJsonSchemaData"},"Meta":{"type":"object","properties":{},"description":"Response metadata.","title":"Meta"},"Price Lists_createPriceList_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPostResponsesContentApplicationJsonSchemaData","description":"Specifies the Common Price List properties."},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"PriceList Response returns for:\n\n* Create a PriceList\n* Get a PriceList\n* Update a PriceList","title":"Price Lists_createPriceList_Response_200"},"PricelistsPostResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{},"title":"PricelistsPostResponsesContentApplicationJsonSchemaErrors"},"CreatePriceListRequestConflictError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPostResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"CreatePriceListRequestConflictError"},"CreatePriceListRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPostResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"CreatePriceListRequestUnprocessableEntityError"},"ServiceUnavailableErrorError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of failure."},"message":{"type":"string","description":"Human-readable summary of the error."},"details":{"type":"string","description":"Additional information about the error."},"retry_after_seconds":{"type":"integer","description":"Number of seconds to wait before retrying the request."},"timestamp":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the error occurred."}},"description":"Top-level error wrapper.","title":"ServiceUnavailableErrorError"},"ServiceUnavailableError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ServiceUnavailableErrorError","description":"Top-level error wrapper."}},"description":"Returned when the service is temporarily unavailable.","title":"ServiceUnavailableError"},"PricelistsPriceListIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numeric ID of the `Price List`; this number increments sequentially.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"name":{"type":"string","description":"The unique name of the Price List. Required in a POST request."},"active":{"type":"boolean","description":"Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Fallback price lists evaluated in order when a price record is not found in this price list. Maximum one layer. Inactive layers are skipped during price resolution but remain assigned.\n"}},"required":["name"],"description":"Specifies the Common Price List properties.","title":"PricelistsPriceListIdGetResponsesContentApplicationJsonSchemaData"},"Price Lists_getPriceList_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdGetResponsesContentApplicationJsonSchemaData","description":"Specifies the Common Price List properties."},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"PriceList Response returns for:\n\n* Create a PriceList\n* Get a PriceList\n* Update a PriceList","title":"Price Lists_getPriceList_Response_200"},"PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numeric ID of the `Price List`; this number increments sequentially.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the `Price List` was created.\n"},"name":{"type":"string","description":"The unique name of the Price List. Required in /POST."},"active":{"type":"boolean","description":"Whether or not this `Price List` and its prices are active.  Defaults to `true`.\n"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerItem"},"description":"Fallback price lists evaluated in order when a price record is not found in this price list. Maximum one layer. Inactive layers are skipped during price resolution but remain assigned.\n"}},"required":["name"],"description":"Common Price List properties.","title":"PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaData"},"Price Lists_updatePriceList_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaData","description":"Common Price List properties."},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"PriceList Response returns for:\n\n* Create a PriceList\n* Get a PriceList\n* Update a PriceList","title":"Price Lists_updatePriceList_Response_200"},"UpdatePriceListRequestNotFoundError":{"type":"object","properties":{"status":{"type":"integer","description":"404 HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error."},"type":{"type":"string"},"instance":{"type":"string"}},"description":"Error payload for the BigCommerce API.","title":"UpdatePriceListRequestNotFoundError"},"PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{},"title":"PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaErrors"},"UpdatePriceListRequestConflictError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"UpdatePriceListRequestConflictError"},"UpdatePriceListRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPriceListIdPutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"UpdatePriceListRequestUnprocessableEntityError"},"AssignmentForGetResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this price list assignment."},"price_list_id":{"type":"integer","description":"Pricelist ID for assignment."},"customer_group_id":{"type":"integer","description":"Customer group ID for assignment."},"channel_id":{"type":"integer","description":"Channel ID for assignment."}},"title":"AssignmentForGetResponse"},"CollectionMetaPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items in the result set.\n"},"count":{"type":"integer","description":"Total number of items in the collection response.\n"},"per_page":{"type":"integer","description":"The amount of items returned in the collection per page, controlled by the limit parameter.\n"},"current_page":{"type":"integer","description":"The page you are currently on within the collection.\n"},"total_pages":{"type":"integer","description":"The total number of pages in the collection.\n"}},"description":"Data related to the response, including pagination and collection totals.","title":"CollectionMetaPagination"},"CollectionMetaCursorPaginationLinks":{"type":"object","properties":{"previous":{"type":"string","description":"Link to the previous page returned in the response."},"current":{"type":"string","description":"Link to the current page returned in the response."},"next":{"type":"string","description":"Link to the next page returned in the response."}},"description":"Pagination links for the previous and next parts of the whole collection.","title":"CollectionMetaCursorPaginationLinks"},"CollectionMetaCursorPagination":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items in the collection response."},"per_page":{"type":"integer","description":"The number of items that can be returned per page, determined by the limit parameter—whether explicitly set, defaulted, or capped at the maximum limit."},"start_cursor":{"type":"string","description":"A string representing the starting point of the current page in the collection."},"end_cursor":{"type":"string","description":"A string representing the ending point of the current page in the collection."},"links":{"$ref":"#/components/schemas/CollectionMetaCursorPaginationLinks","description":"Pagination links for the previous and next parts of the whole collection."}},"title":"CollectionMetaCursorPagination"},"CollectionMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/CollectionMetaPagination","description":"Data related to the response, including pagination and collection totals."},"cursor_pagination":{"$ref":"#/components/schemas/CollectionMetaCursorPagination"}},"description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'","title":"CollectionMeta"},"AssignmentsForGetResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentForGetResponse"}},"meta":{"$ref":"#/components/schemas/CollectionMeta"}},"description":"Array of the price list assignments matching the filter. The response is paginated.","title":"AssignmentsForGetResponse"},"AssignmentsForRequest":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"Price list ID for assignment."},"customer_group_id":{"type":"integer","description":"Customer group ID for assignment."},"channel_id":{"type":"integer","description":"Channel ID for assignment"}},"required":["price_list_id"],"description":"`Price List Assignments` object used in a batch create request.","title":"AssignmentsForRequest"},"CreateBatchPriceListAssignmentsRequest":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentsForRequest"},"description":"Batch of price list assignments.","title":"CreateBatchPriceListAssignmentsRequest"},"Price Lists Assignments_createPriceListAssignments_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Price Lists Assignments_createPriceListAssignments_Response_200"},"PriceListAssignmentsBatchErrorResponseErrors":{"type":"object","properties":{},"title":"PriceListAssignmentsBatchErrorResponseErrors"},"PriceListAssignmentsBatchErrorResponseMeta":{"type":"object","properties":{"saved_records":{"type":"integer"}},"title":"PriceListAssignmentsBatchErrorResponseMeta"},"PriceListAssignmentsBatchErrorResponse":{"type":"object","properties":{"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"errors":{"$ref":"#/components/schemas/PriceListAssignmentsBatchErrorResponseErrors"},"meta":{"$ref":"#/components/schemas/PriceListAssignmentsBatchErrorResponseMeta"}},"title":"PriceListAssignmentsBatchErrorResponse"},"AssignmentForPutRequest":{"type":"object","properties":{"customer_group_id":{"type":"integer","description":"Customer group ID for assignment."},"channel_id":{"type":"integer","description":"Channel ID for assignment"}},"required":["customer_group_id","channel_id"],"title":"AssignmentForPutRequest"},"AssignmentForPutResponseData":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this price list assignment."},"price_list_id":{"type":"integer","description":"Price list ID for assignment."},"customer_group_id":{"type":"integer","description":"Customer group ID for assignment."},"channel_id":{"type":"integer","description":"Channel ID for assignment."}},"title":"AssignmentForPutResponseData"},"AssignmentForPutResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AssignmentForPutResponseData"},"meta":{"$ref":"#/components/schemas/Meta"}},"title":"AssignmentForPutResponse"},"BulkPricingTierType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. \nAcceptable values: \n* price – the adjustment amount per product \n* percent – the adjustment as a percentage of the original price \n* fixed – the adjusted absolute price of the product","title":"BulkPricingTierType"},"BulkPricingTier":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The cart's minimum quantity of associated variants needed to qualify for this tier's pricing."},"quantity_max":{"type":"integer","description":"The cart's maximum allowed quantity of associated variants to qualify for this tier's pricing."},"type":{"$ref":"#/components/schemas/BulkPricingTierType","description":"The type of adjustment that is made. \nAcceptable values: \n* price – the adjustment amount per product \n* percent – the adjustment as a percentage of the original price \n* fixed – the adjusted absolute price of the product"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value and the type will decide the price per variant for the pricing tier."}},"title":"BulkPricingTier"},"PriceRecordBatchItem":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"The price list ID the price record is associated with."},"variant_id":{"type":"integer","description":"The variant with which the price record is associated. Either `variant_id` or `sku` is required."},"sku":{"type":"string","description":"The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required."},"currency":{"type":"string","description":"The 3-letter country code with which this price record is associated."},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. If empty, the sale price will be treated as not being set on this variant."},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant."},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product.  If empty, the retail price will be treated as not being set on this variant."},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the `map_ price` will be treated as not being set on this variant."},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/BulkPricingTier"}}},"required":["price_list_id","currency"],"description":"Common Price Record properties.","title":"PriceRecordBatchItem"},"SuccessBatchResponseData":{"type":"object","properties":{},"title":"SuccessBatchResponseData"},"SuccessBatchResponseMeta":{"type":"object","properties":{},"title":"SuccessBatchResponseMeta"},"SuccessBatchResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SuccessBatchResponseData"},"meta":{"$ref":"#/components/schemas/SuccessBatchResponseMeta"}},"description":"Empty object for Success case for Batch API.","title":"SuccessBatchResponse"},"PriceRecordIdentifiers":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"The Price List with which this price record is associated."},"variant_id":{"type":"integer","description":"The variant with which this price record is associated. Either `variant_id` or `sku` is required."},"sku":{"type":"string","description":"The variant with which this price record is associated. Either `sku` or `variant_id` is required."},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated."}},"description":"The `Price Record` object used in batch create or update.","title":"PriceRecordIdentifiers"},"DetailedErrors":{"type":"object","properties":{},"title":"DetailedErrors"},"PriceRecordBatchErrorResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PriceRecordIdentifiers"},"field_errors":{"$ref":"#/components/schemas/DetailedErrors"}},"description":"Error during `Price Record` batch POST or PUT. Includes data sent in the request and errors.","title":"PriceRecordBatchErrorResponse"},"PricelistsPriceListIdRecordsGetParametersIncludeSchemaItems":{"type":"string","enum":["bulk_pricing_tiers","sku"],"title":"PricelistsPriceListIdRecordsGetParametersIncludeSchemaItems"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for this tier's pricing.\n"},"quantity_max":{"type":["integer","null"],"description":"The maximum allowed quantity of associated variant in the cart to qualify for this tier's pricing. `null` indicates that there is no maximum allowed quantity for this tier.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"calculated_price":{"type":"number","format":"double","description":"The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"product_id":{"type":"integer","description":"The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only.\n"},"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The SKU code associated with this `Price Record` if requested and it exists.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems"}}},"description":"The Price Record object.","title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItems"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items in the result set.\n"},"count":{"type":"integer","description":"Total number of items in the collection response.\n"},"per_page":{"type":"integer","description":"The amount of items returned in the collection per page, controlled by the limit parameter.\n"},"current_page":{"type":"integer","description":"The page you are currently on within the collection.\n"},"total_pages":{"type":"integer","description":"The total number of pages in the collection.\n"}},"description":"Data about the response, including pagination and collection totals.","title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaPagination"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks":{"type":"object","properties":{"previous":{"type":"string","description":"Link to the previous page returned in the response."},"current":{"type":"string","description":"Link to the current page returned in the response."},"next":{"type":"string","description":"Link to the next page returned in the response."}},"description":"Pagination links for the previous and next parts of the whole collection.","title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPagination":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items in the collection response."},"per_page":{"type":"integer","description":"The number of items that can be returned per page, determined by the limit parameter—whether explicitly set, defaulted, or capped at the maximum limit."},"start_cursor":{"type":"string","description":"A string representing the starting point of the current page in the collection."},"end_cursor":{"type":"string","description":"A string representing the ending point of the current page in the collection."},"links":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks","description":"Pagination links for the previous and next parts of the whole collection."}},"title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPagination"},"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaPagination","description":"Data about the response, including pagination and collection totals."},"cursor_pagination":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMetaCursorPagination"}},"description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'","title":"PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMeta"},"Price Lists Records_getPriceListRecords_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsGetResponsesContentApplicationJsonSchemaMeta","description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'"}},"description":"PriceRecord Collection Response returns for:\n* Get All PriceList Records\n* Get PriceList Records by Variant ID","title":"Price Lists Records_getPriceListRecords_Response_200"},"ErrorResponseErrors":{"type":"object","properties":{},"title":"ErrorResponseErrors"},"ErrorResponse":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"},"instance":{"type":"string"},"errors":{"$ref":"#/components/schemas/ErrorResponseErrors"}},"title":"ErrorResponse"},"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems"},"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItems":{"type":"object","properties":{"variant_id":{"type":"integer","description":"The variant ID with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The SKU code associated with this `Price Record` if requested and it exists.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems"}}},"description":"Price Record object used in batch create or update.","title":"PricelistsPriceListIdRecordsPostRequestBodyContentApplicationJsonSchemaItems"},"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaData"},"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaMeta"},"Price Lists Records_createPriceListRecords_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Price Lists Records_createPriceListRecords_Response_200"},"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsData":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant ID with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The variant with which this price set is associated. Either `sku` or `variant_id` is required.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"}},"description":"Price Record object used in batch create or update.","title":"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsData"},"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors"},"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsData","description":"Price Record object used in batch create or update."},"field_errors":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors"}},"description":"Error during Price Record batch POST request. Includes data sent in the request and errors.","title":"PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItems"},"CreatePriceListRecordsRequestUnprocessableEntityError":{"type":"object","properties":{"batch_errors":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPostResponsesContentApplicationJsonSchemaBatchErrorsItems"}}},"description":"Errors during batch usage for the BigCommerce API.","title":"CreatePriceListRecordsRequestUnprocessableEntityError"},"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems"},"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItems":{"type":"object","properties":{"variant_id":{"type":"integer","description":"The variant ID with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The SKU code associated with this `Price Record` if requested and it exists.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItemsBulkPricingTiersItems"}}},"description":"Price Record object used in batch create or update.","title":"PricelistsPriceListIdRecordsPutRequestBodyContentApplicationJsonSchemaItems"},"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaData"},"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaMeta"},"Price Lists Records_upsertPriceListRecords_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Price Lists Records_upsertPriceListRecords_Response_200"},"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsData":{"type":"object","properties":{"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant ID with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The variant with which this price set is associated. Either `sku` or `variant_id` is required.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"}},"description":"Price Record object used in batch create or update.","title":"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsData"},"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors"},"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsData","description":"Price Record object used in batch create or update."},"field_errors":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItemsFieldErrors"}},"description":"Error during Price Record batch PUT request. Includes data sent in the request and errors.","title":"PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItems"},"UpsertPriceListRecordsRequestUnprocessableEntityError":{"type":"object","properties":{"batch_errors":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsPutResponsesContentApplicationJsonSchemaBatchErrorsItems"}}},"description":"Errors during batch usage for the BigCommerce API.","title":"UpsertPriceListRecordsRequestUnprocessableEntityError"},"PricelistsPriceListIdRecordsVariantIdGetParametersIncludeSchemaItems":{"type":"string","enum":["bulk_pricing_tiers","sku"],"title":"PricelistsPriceListIdRecordsVariantIdGetParametersIncludeSchemaItems"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"calculated_price":{"type":"number","format":"double","description":"The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"product_id":{"type":"integer","description":"The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only.\n"},"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant ID with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The SKU code associated with this `Price Record` if requested and it exists.\n"},"currency":{"type":"string","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingTiersItems"}}},"description":"The Price Record object.","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItems"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items in the result set.\n"},"count":{"type":"integer","description":"Total number of items in the collection response.\n"},"per_page":{"type":"integer","description":"The amount of items returned in the collection per page, controlled by the limit parameter.\n"},"current_page":{"type":"integer","description":"The page you are currently on within the collection.\n"},"total_pages":{"type":"integer","description":"The total number of pages in the collection.\n"}},"description":"Data related to the response, including pagination and collection totals.","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaPagination"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks":{"type":"object","properties":{"previous":{"type":"string","description":"Link to the previous page returned in the response."},"current":{"type":"string","description":"Link to the current page returned in the response."},"next":{"type":"string","description":"Link to the next page returned in the response."}},"description":"Pagination links for the previous and next parts of the whole collection.","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPagination":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of items in the collection response."},"per_page":{"type":"integer","description":"The number of items that can be returned per page, determined by the limit parameter—whether explicitly set, defaulted, or capped at the maximum limit."},"start_cursor":{"type":"string","description":"A string representing the starting point of the current page in the collection."},"end_cursor":{"type":"string","description":"A string representing the ending point of the current page in the collection."},"links":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPaginationLinks","description":"Pagination links for the previous and next parts of the whole collection."}},"description":"Data about cursor pagination.","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPagination"},"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaPagination","description":"Data related to the response, including pagination and collection totals."},"cursor_pagination":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMetaCursorPagination","description":"Data about cursor pagination."}},"description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'","title":"PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMeta"},"Price Lists Records_getPriceListRecordsByVariantId_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdGetResponsesContentApplicationJsonSchemaMeta","description":"'Contains data about paginating the response via cursors. If no pagination details are specified or if you only provide a limit, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present.'"}},"description":"PriceRecord Collection Response returns for:\n* Get All PriceList Records\n* Get PriceList Records by Variant ID","title":"Price Lists Records_getPriceListRecordsByVariantId_Response_200"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetParametersIncludeSchemaItems":{"type":"string","enum":["bulk_pricing_tiers","sku"],"title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetParametersIncludeSchemaItems"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"calculated_price":{"type":"number","format":"double","description":"The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"product_id":{"type":"integer","description":"The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only.\n"},"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"sku":{"type":"string","description":"The SKU code associated with this `Price Record` if requested and it exists.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems"}}},"description":"The Price Record object.","title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaData"},"Price Lists Records_getPriceListRecord_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodeGetResponsesContentApplicationJsonSchemaData","description":"The Price Record object."},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"Response payload for the BigCommerce API.","title":"Price Lists Records_getPriceListRecord_Response_200"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutRequestBodyContentApplicationJsonSchemaBulkPricingTiersItems"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType":{"type":"string","enum":["fixed","price","percent"],"description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n","title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems":{"type":"object","properties":{"quantity_min":{"type":"integer","description":"The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier.\n"},"quantity_max":{"type":"integer","description":"The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier.\n"},"type":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItemsType","description":"The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.\n"},"amount":{"type":"number","format":"double","description":"The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.\n"}},"title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"calculated_price":{"type":"number","format":"double","description":"The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only.\n"},"date_created":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"date_modified":{"type":"string","format":"date-time","description":"The date on which the Price entry was created.\n"},"product_id":{"type":"integer","description":"The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only.\n"},"price_list_id":{"type":"integer","description":"The Price List with which this price set is associated.\n"},"variant_id":{"type":"integer","description":"The variant with which this price set is associated. Either `variant_id` or `sku` is required.\n"},"currency":{"type":"string","format":"ISO-4217","description":"The 3-letter currency code with which this price set is associated.\n"},"price":{"type":"number","format":"double","description":"The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.\n"},"sale_price":{"type":"number","format":"double","description":"The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.\n"},"retail_price":{"type":"number","format":"double","description":"The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product.  If empty, the retail price will be treated as not being set on this variant.\n"},"map_price":{"type":"number","format":"double","description":"The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.\n"},"bulk_pricing_tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaDataBulkPricingTiersItems"}}},"description":"The Price Record object.","title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaData"},"Price Lists Records_setPriceListRecord_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaData","description":"The Price Record object."},"meta":{"$ref":"#/components/schemas/Meta"}},"description":"Response payload for the BigCommerce API.","title":"Price Lists Records_setPriceListRecord_Response_200"},"SetPriceListRecordRequestNotFoundError":{"type":"object","properties":{"status":{"type":"integer","description":"404 HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error."},"type":{"type":"string"},"instance":{"type":"string"}},"description":"Error payload for the BigCommerce API.","title":"SetPriceListRecordRequestNotFoundError"},"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{},"title":"PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaErrors"},"SetPriceListRecordRequestConflictError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"SetPriceListRecordRequestConflictError"},"SetPriceListRecordRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/PricelistsPriceListIdRecordsVariantIdCurrencyCodePutResponsesContentApplicationJsonSchemaErrors"},"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"}},"title":"SetPriceListRecordRequestUnprocessableEntityError"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Products | modify | `store_v2_products` |\n|  Products | read-only | `store_v2_products_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}