To get documents through the Business Documents API, make an HTTP GET request to the following endpoints:
- Level selection endpoints:
/account-level-resources: Fetch the list of available resources at the account level./business-unit-level-resources: Fetch the list of available resources at the business unit level./business-documents: Fetch the list of available documents at the selected level./business-document: Fetch a specific document at the selected level.
Start calling the API with one of the above endpoints.
To learn more about calling the API, see Calling the Business Documents API.
Exported business documents
The complete list of the XML and JSON files exported via API is presented in the sections below.
Documents exported at the account level
To export XML/JSON files at the account level, start calling the API from the /account-level-resources endpoint with the following document type identifier:
- Item Catalogue:
price-book-item - Products Hierarchy Catalogue (Taxonomy)
- Categories:
categories - Departments:
departments - Price Groups:
price-groups - Promo Groups:
promo-groups - Item Tags:
item-tags
Documents exported at the business unit level
To export XML/JSON files at the business unit level, start calling the API from the /business-unit-level-resourcesendpoint with the following document type identifier:
- Cost of Goods Sold:
cost-of-goods-sold - Fuel Products Cost of Goods Sold:
fuel-products-cost-of-goods-sold - Cycle Count Physical Inventory:
inventory-item - Itemized Inventory:
report-exported - POS Journal Reports (TLogs):
pos-journal-report - Shift Reports
- Fuel Grade Movement (FGM) Report:
shift_fuel-grade-movement - Item Sales Movement (ISM) Report:
shift_item-sales-movement - Merchandise Code Movement (MCM) Report:
shift_merchandise-code-movement - Miscellaneous Summary Movement (MSM) Report:
shift_miscellaneous-summary-movement - Store Purchases (Invoice):
invoice - General Journal:
general-journal-report - Lottery Purchases (Invoice):
lottery-purchase - Lottery Sales:
lottery-sale - NAXML Maintenance Reports:
maintenance-reports
Before you begin
Before you start using the Business Documents API, you need:
- Get the API authorization token.
- Prepare the input parameters for API request.
This step is required only if you call the API at the business unit level.
