Item Resources
Item related resources. includes: items, price_lists, special_price_lists, item_prices, inventory, item dimensions1, item dimensions2.
Items
https://api.pepperi.com/v1.0/items/externalid/{id}
Retrieves a single item by external id.
https://api.pepperi.com/v1.0/totals/items
Retrieves aggregated data for the items resource.
https://api.pepperi.com/v1.0/metadata/items
{Beta} Retrieves the items metadata(schema).
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.
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.
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.
https://api.pepperi.com/v1.0/metadata/items
{Beta} Adds a new User Defined Field to the items schema.
https://api.pepperi.com/v1.0/items/{id}
Deletes a single item by internal id.
https://api.pepperi.com/v1.0/items/externalid/{id}
Deletes a single item by external id.
Inventory
method
description
https://api.pepperi.com/v1.0/inventory
Retrieves a list of item inventory including details about each item inventory and its nested objects.
https://api.pepperi.com/v1.0/totals/inventory
Retrieves aggregated data for the inventory resource.
https://api.pepperi.com/v1.0/metadata/inventory
{Beta} Retrieves the item inventory metadata(schema).
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.
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.
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
https://api.pepperi.com/v1.0/price_lists
Retrieves a list of price_lists including details about each price list and its nested objects.
https://api.pepperi.com/v1.0/price_lists/{id}
Retrieves a single price list by internal id.
https://api.pepperi.com/v1.0/price_lists/externalid/{id}
Retrieves a single price list by external id.
https://api.pepperi.com/v1.0/totals/price_lists
Retrieves aggregated data for the price_lists resource.
https://api.pepperi.com/v1.0/metadata/price_lists
{Beta} Retrieves the price_lists metadata(schema).
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.
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.
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.
https://api.pepperi.com/v1.0/price_lists/{id}
Deletes a single price list by internal id.
https://api.pepperi.com/v1.0/price_lists/externalid/{id}
Deletes a single price list by external id.
Special Price Lists
method
description
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.
https://api.pepperi.com/v1.0/special_price_lists/{id}
Retrieves a single special price list by internal id.
https://api.pepperi.com/v1.0/special_price_lists/externalid/{id}
Retrieves a single special price list by external id.
https://api.pepperi.com/v1.0/totals/special_price_lists
Retrieves aggregated data for the special_price_lists resource.
https://api.pepperi.com/v1.0/metadata/special_price_lists
{Beta} Retrieves the special_price_lists metadata(schema).
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.
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.
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.
https://api.pepperi.com/v1.0/special_price_lists/{id}
Deletes a single special price list by internal id.
https://api.pepperi.com/v1.0/special_price_lists/externalid/{id}
Deletes a single special price list by external id.
Item Prices
method
description
https://api.pepperi.com/v1.0/item_prices
Retrieves a list of item prices including details about each item price and its nested objects.
https://api.pepperi.com/v1.0/totals/item_prices
Retrieves aggregated data for the item_prices resource.
https://api.pepperi.com/v1.0/metadata/item_prices
{Beta} Retrieves the item prices metadata(schema).
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.
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.
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
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.
https://api.pepperi.com/v1.0/totals/item_dimensions1
Retrieves aggregated data for the item_dimensions1 resource.
https://api.pepperi.com/v1.0/metadata/item_dimensions1
{Beta} Retrieves the item_dimensions1 metadata(schema).
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.
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.
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
https://api.pepperi.com/v1.0/item_dimensions2
{Beta} Retrieves a list of dimensions2 (e.g: list of Colors) including details about each dimensions1 and its nested objects.
https://api.pepperi.com/v1.0/totals/item_dimensions2
Retrieves aggregated data for the item_dimensions2 resource.
https://api.pepperi.com/v1.0/metadata/item_dimensions2
{Beta} Retrieves the item_dimensions2 metadata(schema).
https://api.pepperi.com/v1.0/item_dimensions2
{Beta} Upserts (updates/inserts) a single dimensions2 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.
https://api.pepperi.com/v1.0/bulk/item_dimensions2/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.
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.