Skip to main content

Pricebook Export (1.0.0)

Download OpenAPI specification:Download

Pricebook Export API

Pricebook export

Pricebook Export

showPricebookExport

Use this resource to export a specific price book. The export can be requested in CSV or SQLite format. The export contains the following fields:

product_id (string) price (float32) currency_code (string)
prod1 16.99 USD

Export API are not immediately scheduling new export. Exports are automatically scheduled daily. Usually at 8:00 UTC. They are usually finished before 9:00 UTC. API can be used to retrieve max 1 day old snapshot of pricing data.

Response header Last-Modified can be used to determine when file was updated last time (example value Mon, 18 Dec 2023 08:00:21 GMT). Response header ETag can be used to determine whether version you already downloaded before match current one. (example value "2ad5ba4e24fe1c0d225e9a94049f142d") Please use it with combination with If-None-Match request header to download file only when something changed.

Authorizations:
oauth
path Parameters
catalog
required
string >= 1

The catalog the pricebook, the user wants to export, belongs to.

pricebook
required
string >= 1

The pricebook the user wants to export.

query Parameters
format
string
Default: "csv"
Enum: "csv" "sqlite"

The desired response format, defaults to 'csv'.

Responses

Response samples

Content type
application/problem+json
{
  • "request_id": "request1234",
  • "messages": [
    ],
  • "error_code": "400"
}