Retrieves a paginated list of receipt orders for a specific store.

ReceiptListStoreReceiptsPageResponse Receipts.ListStoreReceipts(, )

GET/api/v2/public/stores/{store_number}/orders/receipts

ParametersExpand Collapse

ReceiptListStoreReceiptsParams parameters

required string storeNumber

The store number.

required Int receiptType

The receipt type (required).

formatint32

Long fromID

Filter from this receipt ID.

formatint64

Boolean isSubmitted

Filter by submission status.

DateTimeOffset lastModifiedDate

Filter by last modified date.

formatdate-time

string orderNumber

Filter by order number.

Int pageSize

formatint32

Int pageStart

formatint32

Long toID

Filter up to this receipt ID.

formatint64

ReturnsExpand Collapse

class ReceiptListStoreReceiptsPageResponse:

Generic paginated response wrapper.

required Int PageSize

Maximum number of items returned per page.

formatint32

required Int PageStart

Current page number (1-based).

formatint32

required Long TotalCount

Total number of records matching the query across all pages.

formatint64

IReadOnlyList<ReceiptListStoreReceiptsResponse>? List

Collection of items for the current page.

required DateTimeOffset DatetimeCreated

formatdate-time

required DateTimeOffset DatetimeExpected

formatdate-time

required Long ImportID

formatint64

required Int OrderTypeID

formatint32

required DateTimeOffset UpdatedOn

formatdate-time

string? OrderNumber

IReadOnlyList<ReceiptLine>? ReceiptLines

required Long ID

formatint64

required Double PurchasePrice

formatdouble

required Double ReceivedQuantity

formatdouble

required Double ShippedQuantity

formatdouble

required Double StoreProductsPrice

formatdouble

required DateTimeOffset UpdatedOn

formatdate-time

string? Barcode

string? CategoryCode

string? ContainerBarcode

string? Description

string? GroupCode

Int? LineNumber

formatint32

string? ProductNumber

string? Status

string? StoreGln

string? StoreNumber

string? SupplierCode

string? SupplierName

IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

Active filter criteria applied to the result set, keyed by field name.

Int? NextPage

Next page number, or null when on the last page.

formatint32

Long? PreviousPage

Previous page number, or null when on the first page.

formatint64

string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction (asc or desc).

string? TaskLastModifiedDate

Last modified date/time of the task.

Retrieves a paginated list of receipt orders for a specific store.

ReceiptListStoreReceiptsParams parameters = new()
{
    StoreNumber = "store_number",
    ReceiptType = 0,
};

var page = await client.Receipts.ListStoreReceipts(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "order_number": "order_number",
      "receipt_lines": [
        {
          "id": 0,
          "purchase_price": 0,
          "received_quantity": 0,
          "shipped_quantity": 0,
          "store_products_price": 0,
          "updated_on": "2019-12-27T18:11:19.117Z",
          "barcode": "barcode",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

Returns Examples

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "order_number": "order_number",
      "receipt_lines": [
        {
          "id": 0,
          "purchase_price": 0,
          "received_quantity": 0,
          "shipped_quantity": 0,
          "store_products_price": 0,
          "updated_on": "2019-12-27T18:11:19.117Z",
          "barcode": "barcode",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}