Skip to main content
Version: v3 (preview)

Get Many Line Items​

Returns the line items on your organization's orders, newest order first, with each order's line items in the order they appear on it.

Query Parameters
  • page integer required

    Page to return. Pages start at 0

  • limit integer required

    Possible values: >= 1 and <= 500

    Number of records per page, up to 500

  • orderId uuid

    Only return line items on this order

  • itemId uuid

    Only return line items for this item

  • itemBatchId uuid

    Only return line items for this item batch

  • startCreatedAt date

    Only return line items created on or after this date, in yyyy-mm-dd format

  • endCreatedAt date

    Only return line items created on or before this date, in yyyy-mm-dd format

  • startUpdatedAt date

    Only return line items updated on or after this date, in yyyy-mm-dd format

  • endUpdatedAt date

    Only return line items updated on or before this date, in yyyy-mm-dd format

  • startDeliveryDate date

    Only return line items whose order is delivered on or after this date, in yyyy-mm-dd format

  • endDeliveryDate date

    Only return line items whose order is delivered on or before this date, in yyyy-mm-dd format

Responses

Successful Operation

Schema
  • data object[]
  • id uuid

    Nabis ID of the line item

  • orderId uuid

    Nabis ID of the order the line item is on. See Get Order by Nabis ID

  • itemBatchId uuid

    Nabis ID of the item batch ordered. See Get Inventory by Nabis ID

  • itemId uuid

    Nabis ID of the item ordered

  • batchId uuid

    Nabis ID of the batch ordered

  • name string

    Name of the item when it was ordered

  • code string

    Code of the item when it was ordered

  • unit string

    Description of a single unit of the item when it was ordered (e.g. 6-pack)

  • quantity integer

    Number of units ordered

  • pricePerUnit number

    Price of a single unit on this order, before discounts

  • itemPricePerUnit number

    The item's standard price for a single unit when it was ordered

  • taxInclusivePrice number

    Price of a single unit including tax. Only set when the order uses tax-inclusive pricing (taxInclusivePricing on the order)

  • discount number

    Discount applied to the line item, for the whole line

  • promotionsDiscount number

    Discount from promotions applied to the line item, for the whole line

  • flatDiscountAmount number

    The line item's share of any flat discount applied to the whole order

  • isSample boolean

    Whether the line item is a sample

  • sampleType string

    Possible values: [TRADE_SAMPLE, DONATION, DISPLAY_SAMPLE]

    Kind of sample. null when the line item isn't a sample

  • lineItemManifestNotes string

    Notes on the line item that appear on the order's manifest

  • createdAt date-time

    When the line item was created

  • updatedAt date-time

    When the line item was last updated

  • page integer

    The page returned

  • totalCount integer

    Total number of records across all pages

  • totalNumPages integer

    Total number of pages

  • nextPage integer

    The next page, or null on the last page

  • prevPage integer

    The previous page, or null on the first page