Retrieve price books

get https://virtserver.swaggerhub.com/Tillersystems/Catalog/1.0.0/catalogs/v1/{storeId}/price-books/partners

Retrieve a list of price books associated with the partner

Responses

Response body

array of objects

object

integer

required

Id of the price book.

name

string

Name of the price book.

plannings

array of objects

The list of plannings during which the price book is active.

plannings

object

integer

required

Id of the planning.

activeDays

array of strings

activeDays

startTime

string

Start schedule time in ISO8601 as THH:mmZ

endTime

string

End schedule time in ISO8601 as THH:mmZ

products

array of objects

The list of products associated with the price book.

products

object

integer

required

The product id.

name

string

The name of the product.

category

object

required

The category of the product.

sku

string

The sku assigned to the product.

unitPrice

object

The base price of the product in cents.

tax

object

The tax rate applied to the product.

optionsChoices

array of objects

optionsChoices

object

integer

required

Id identifying the choice of options.

limit

integer

The limit of the number of options that can be selected.\n-1 = unlimited

optionCategory

object

The list of options associated with this group.

media

object

Images associated with the product.

description

string

The product description.

visible

boolean

True if the product is visible in the catalog.

packages

array of objects

The list of packages associated with the price book.

packages

object

integer

required

Id of the package.

name

string

Name of the package.

description

string

Description of the package.

price

object

The base price of this package (excludes tax in the US, includes tax in the EU).

color

string

Color of the package.

components

array of objects

List of products associated with the package.

components

object

integer

required

Id of the package component.

name

string

required

Name of the package component.

productSelection

array of objects

List of products selected in this package component.

productSelection

object

productInComponent

object

Information about a product.

extraPrice

object

position

integer

Package choice position (sort in ascending order).

preparation

integer

Order of preparation of this component.\nDirect = 0, Suite 1 = 1, Suite 2 = 2, etc.

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://virtserver.swaggerhub.com/Tillersystems/Catalog/1.0.0/catalogs/v1//price-books/partners \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

404Not Found

500Internal Server Error