PublicApi

PurchaseOrderListResponse

object
page_numberinteger

The current page number

purchase_ordersarray[object]

A purchase order

Show Child Parameters
total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

Example

PurchaseOrder

object

A purchase order

store_idstring

The ID of the store that the purchase order is for

datestring

The date the purchase order was received

purchase_order_idstring

The id of the purchase order

supplier_invoice_numberstring

The supplier invoice reference

supplier_idstring

The ID of the supplier within this system

purchase_order_linesarray[object]

A purchase order

Show Child Parameters
Example

Stock Transfer Summary Response

object
summary_linesarray[object]

A summary of stock transfers for a given store on a given date

Show Child Parameters
page_numberinteger

The current page number

total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

Example

SupplierInvoiceListResponse

object
supplier_invoicesarray[object]

A supplier invoice

Show Child Parameters
page_numberinteger

The current page number

total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

Example

Store List Response

object
page_numberinteger

The current page number

storesarray[object]

A retail store/outlet

Show Child Parameters
total_recordsinteger

The total number of records in your query

total_pagesinteger

The total number of pages in your query

page_sizeinteger

The maximum number of records in a single page

Example