Item related resources. includes: items, price_lists, special_price_lists, item_prices, inventory, item dimensions1, item dimensions2.

Items

Method
Description

GET

get-items

https://api.pepperi.com/v1.0/items

Retrieves a list of items including details about each item and its nested objects.

GET

get-item-by-id

https://api.pepperi.com/v1.0/items/{id}

Retrieves a single item by internal id.

GET

get-item-by-externalid

https://api.pepperi.com/v1.0/items/externalid/{id}

Retrieves a single item by external id.

GET

get-items-totals

https://api.pepperi.com/v1.0/totals/items

Retrieves aggregated data for the items resource.

GET

get-items-metadata

https://api.pepperi.com/v1.0/metadata/items

{Beta} Retrieves the items metadata(schema).

POST

post-items

https://api.pepperi.com/v1.0/items

Upserts (updates/inserts) a single item data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-items-bulk-json

https://api.pepperi.com/v1.0/bulk/items/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple items data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-items-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/items/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple items data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-items-metadata-udf

https://api.pepperi.com/v1.0/metadata/items

{Beta} Adds a new User Defined Field to the items schema.

DELETE

delete-item-by-id

https://api.pepperi.com/v1.0/items/{id}

Deletes a single item by internal id.

DELETE

delete-item-by-externalid

https://api.pepperi.com/v1.0/items/externalid/{id}

Deletes a single item by external id.

Inventory

Method
Description

GET

get-inventory

https://api.pepperi.com/v1.0/inventory

Retrieves a list of item inventory including details about each item inventory and its nested objects.

GET

get-inventory-totals

https://api.pepperi.com/v1.0/totals/inventory

Retrieves aggregated data for the inventory resource.

GET

get-inventory-metadata

https://api.pepperi.com/v1.0/metadata/inventory

{Beta} Retrieves the item inventory metadata(schema).

POST

post-inventory

https://api.pepperi.com/v1.0/inventory

Upserts (updates/inserts) a single item inventory data. Item ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-inventory-bulk-json

https://api.pepperi.com/v1.0/bulk/inventory/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple item inventory data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. Item ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-inventory-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/inventory/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple inventory data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. Item ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

Price Lists

Method
Description

GET

get-price_lists

https://api.pepperi.com/v1.0/price_lists

Retrieves a list of price_lists including details about each price list and its nested objects.

GET

get-price list-by-id

https://api.pepperi.com/v1.0/price_lists/{id}

Retrieves a single price list by internal id.

GET

get-price list-by-externalid

https://api.pepperi.com/v1.0/price_lists/externalid/{id}

Retrieves a single price list by external id.

GET

get-price_lists-totals

https://api.pepperi.com/v1.0/totals/price_lists

Retrieves aggregated data for the price_lists resource.

GET

get-price_lists-metadata

https://api.pepperi.com/v1.0/metadata/price_lists

{Beta} Retrieves the price_lists metadata(schema).

POST

post-price_lists

https://api.pepperi.com/v1.0/price_lists

Upserts (updates/inserts) a single price list data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-price_lists-bulk-json

https://api.pepperi.com/v1.0/bulk/price_lists/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple price_lists data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-price_lists-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/price_lists/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple price_lists data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

DELETE

delete-price list-by-id

https://api.pepperi.com/v1.0/price_lists/{id}

Deletes a single price list by internal id.

DELETE

delete-price list-by-externalid

https://api.pepperi.com/v1.0/price_lists/externalid/{id}

Deletes a single price list by external id.

Special Price Lists

Method
Description

GET

get-special_price_lists

https://api.pepperi.com/v1.0/special_price_lists

Retrieves a list of special_price_lists including details about each special price list and its nested objects.

GET

get-special price list-by-id

https://api.pepperi.com/v1.0/special_price_lists/{id}

Retrieves a single special price list by internal id.

GET

get-special price list-by-externalid

https://api.pepperi.com/v1.0/special_price_lists/externalid/{id}

Retrieves a single special price list by external id.

GET

get-special_price_lists-totals

https://api.pepperi.com/v1.0/totals/special_price_lists

Retrieves aggregated data for the special_price_lists resource.

GET

get-special_price_lists-metadata

https://api.pepperi.com/v1.0/metadata/special_price_lists

{Beta} Retrieves the special_price_lists metadata(schema).

POST

post-special_price_lists

https://api.pepperi.com/v1.0/special_price_lists

Upserts (updates/inserts) a single special price list data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-special_price_lists-bulk-json

https://api.pepperi.com/v1.0/bulk/special_price_lists/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple special_price_lists data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-special_price_lists-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/special_price_lists/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple special_price_lists data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

DELETE

delete-special price list-by-id

https://api.pepperi.com/v1.0/special_price_lists/{id}

Deletes a single special price list by internal id.

DELETE

delete-special price list-by-externalid

https://api.pepperi.com/v1.0/special_price_lists/externalid/{id}

Deletes a single special price list by external id.

Item Prices

Method
Description

GET

get-item_prices

https://api.pepperi.com/v1.0/item_prices

Retrieves a list of item prices including details about each item price and its nested objects.

GET

get-item_prices-totals

https://api.pepperi.com/v1.0/totals/item_prices

Retrieves aggregated data for the item_prices resource.

GET

get-item_prices-metadata

https://api.pepperi.com/v1.0/metadata/item_prices

{Beta} Retrieves the item prices metadata(schema).

POST

post-item_prices

https://api.pepperi.com/v1.0/item_prices

Upserts (updates/inserts) a single item price data. In order to DELETE an item price Set the Hidden field to true.

POST

post-item_prices-bulk-json

https://api.pepperi.com/v1.0/bulk/item_prices/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple item prices data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. In order to DELETE an item price Set the Hidden field to true.

POST

post-item_prices-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/item_prices/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple item prices data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. In order to DELETE an item price Set the Hidden field to true.

Item Dimensions1 (e.g: Colors)

Method
Description

GET

get-item_dimensions1

https://api.pepperi.com/v1.0/item_dimensions1

{Beta} Retrieves a list of dimensions1 (e.g: list of Colors) including details about each dimensions1 and its nested objects.

GET

get-item_dimensions1-totals

https://api.pepperi.com/v1.0/totals/item_dimensions1

Retrieves aggregated data for the item_dimensions1 resource.

GET

get-item_dimensions1-metadata

https://api.pepperi.com/v1.0/metadata/item_dimensions1

{Beta} Retrieves the item_dimensions1 metadata(schema).

POST

post-item_dimensions1

https://api.pepperi.com/v1.0/item_dimensions1

{Beta} Upserts (updates/inserts) a single dimensions1 data( e.g: a single Color) . Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.

POST

post-item_dimensions1-bulk-json

https://api.pepperi.com/v1.0/bulk/item_dimensions1/json

{Beta} Starts a new async bulk upload job that upserts (updates/inserts) multiple item_dimensions1 data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.

POST

post-item_dimensions1-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/item_dimensions1/csv_zip

{Beta} Starts a new async bulk upload job that upserts (updates/inserts) multiple item_dimensions1 data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.

Item Dimensions2 (e.g: Sizes)

Method
Description

GET

get-item_dimensions2

https://api.pepperi.com/v1.0/item_dimensions2

{Beta} Retrieves a list of dimensions2 (e.g: list of Sizes) including details about each dimensions2 and its nested objects.

GET

get-item_dimensions2-totals

https://api.pepperi.com/v1.0/totals/item_dimensions2

Retrieves aggregated data for the item_dimensions2 resource.

GET

get-item_dimensions2-metadata

https://api.pepperi.com/v1.0/metadata/item_dimensions2

{Beta} Retrieves the item_dimensions2 metadata(schema).

POST

post-item_dimensions2

https://api.pepperi.com/v1.0/item_dimensions2

{Beta} Upserts (updates/inserts) a single dimensions2 data( e.g: a single Size) . Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.

POST

post-item_dimensions2-bulk-json

https://api.pepperi.com/v1.0/bulk/item_dimensions2/json

{Beta} Starts a new async bulk upload job that upserts (updates/inserts) multiple item_dimensions2 data as a list of headers and lines. This async request returns a Job ID and URI to query the job's status. Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.

POST

post-item_dimensions2-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/item_dimensions2/csv_zip

{Beta} Starts a new async bulk upload job that upserts (updates/inserts) multiple item_dimensions2 data as a zip file that contains a single csv file. This async request returns a Job ID and URI to query the job's status. Dimension Code is required in case of insert and either InternalID or Code are required in case of update. In order to DELETE Set the Hidden field to true.