Account related resources. (an Account is defined by the Type Field and usually represents a Customer/Vendor/Warehouse). includes: accounts, contacts, account_users, account_catalogs, account_inventory.

Accounts

method

description

get

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

Retrieves a list of accounts including details about each account and its nested objects.

get

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

Retrieves a single account by internal id.
 

get

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

Retrieves a single account by external id.
 

get

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

Retrieves aggregated data for the accounts resource.
 

get

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

{Beta} Retrieves the accounts metadata(schema).
 
 

post

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

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

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple accounts 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

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple accounts 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

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

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

delete

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

Deletes a single account by internal id.
 

delete

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

Deletes a single account by external id.
 

Contacts

method

description

get

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

Retrieves a list of contacts including details about each contact and its nested objects.

get

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

Retrieves a single contact by internal id.

get

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

Retrieves a single contact by external id.
 

get

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

Retrieves aggregated data for the contacts resource.
 

get

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

{Beta} Retrieves the contacts metadata(schema).

post

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

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

post

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

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

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple contacts 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 and Account ExternalID are required in case of insert and either InternalID or ExternalID are required in case of update.

delete

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

Deletes a single contact by internal id.
 

delete

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

Deletes a single contact by external id.
 

Account Users

method

description

get

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

Retrieves a list of account users including details about each account user and its nested objects.

get

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

Retrieves aggregated data for the account_users resource.

get

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

{Beta} Retrieves the account_users metadata(schema).
 

post

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

Upserts (updates/inserts) a single account users data . In order to DELETE Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_users 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 Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_users 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 Set the Hidden field to true.

Catalogs

method

description

get

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

Retrieves a list of catalogs including details about each catalog and its nested objects.

get

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

Retrieves aggregated data for the catalogs resource.

get

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

{Beta} Retrieves the catalogs metadata(schema).
 

Account Catalogs

method

description

get

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

Retrieves a list of account catalogs including details about each account catalog and its nested objects.

get

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

Retrieves aggregated data for the account_catalogs resource.

get

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

{Beta} Retrieves the account_catalogs metadata(schema).
 

post

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

Upserts (updates/inserts) a single account catalogs data . In order to DELETE Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_catalogs 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 Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_catalogs 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 Set the Hidden field to true.

Account Inventory

method

description

get

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

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

get

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

Retrieves aggregated data for the account_inventory resource.

get

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

{Beta} Retrieves the account_inventory metadata(schema).
 

post

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

Upserts (updates/inserts) a single account inventory data . In order to DELETE Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_inventory 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 Set the Hidden field to true.

post

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

Starts a new async bulk upload job that upserts (updates/inserts) multiple account_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. In order to DELETE Set the Hidden field to true.

Account Sellout

method

description

get

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

Retrieves a list of account sellout objects including details about each account sellout information and its nested objects.

get

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

Retrieves aggregated data for the account_sellout resource.

get

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