Download OpenAPI specification:
(v1.0) LS Central retailCore API for Dynamics 365 Business Central. Published by the LS Central AL API pages at /api/lsRetail/retailCore/v1.0.
Exposes Currency (table 4) master data — code, description, rounding precision, and the LSC-specific POS presentation attributes (currency symbol and its placement) — as a read-only OData v4 entity. Replaces the legacy RetailWebServices read used by LS Omni''s CurrencyGetById(id, culture) operation (GetGeneralWebRequestXML("Currency", "Code", id)). Microsoft''s own standard v2.0 currencies API does not project the POS-specific rounding/symbol fields exposed here, so this is a separate, purpose-built endpoint. This release is read-only: Insert, Modify, and Delete are not supported over the API; currencies are maintained through the LS Central back-office UI.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "amountRoundingPrecision" "invoiceRoundingPrecision" "posCurrencySymbol" "placementOfCurrencySymbol" "invoiceRoundingType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "amountRoundingPrecision": null,
- "invoiceRoundingPrecision": null,
- "posCurrencySymbol": null,
- "placementOfCurrencySymbol": null,
- "invoiceRoundingType": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| currency-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of currency |
| $select | Array of strings unique Items Enum: "id" "code" "description" "amountRoundingPrecision" "invoiceRoundingPrecision" "posCurrencySymbol" "placementOfCurrencySymbol" "invoiceRoundingType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "amountRoundingPrecision": null,
- "invoiceRoundingPrecision": null,
- "posCurrencySymbol": null,
- "placementOfCurrencySymbol": null,
- "invoiceRoundingType": null,
- "lastModifiedDateTime": null
}Exposes the legacy SOAP GetCustomerCard operation (LSCGetCustomerCard / LSCGetCustomerCardUtils codeunits) as a standalone, read-only OData v4 entity. This is a top-level lookup, not nested under another entity: a caller supplies the customer to look up via the customerNo filter, e.g. GET .../customerCardLines?$filter=customerNo eq ''10000''. An omitted or non-resolving customerNo filter is not an error condition — it simply returns an empty result set. Each row is a computed (label, value) pair built fresh from a single Customer record on every request — this is not a persisted table, so there is no meaningful "last modified" timestamp for a row and lastModifiedDateTime is deliberately not exposed. The 12 rows, their labels, and their order exactly match the legacy operation''s output: Customer No, Name, Address, Address2, Postcode/City (Post Code and City concatenated with ''/''), Country, Phone No., E-Mail, Contact, Blocked, Balance, Credit Limit. viewCode is a verbatim echo of the request, matching legacy''s View parameter: ''01'' against a resolving customer returns zero rows (not an error — the customer still resolved, the requested view simply has none); blank or any other value (legacy has no ''02''/''03'' branch here) returns the full 12-row dump. A viewCode filter expression is treated as no criterion. The underlying "LSC WS Line Buffer" table (also used, unaffected, by several legacy SOAP web service codeunits) and its "Source No." extension field, together with "LSC Card Line Buffer Mgt", are intentionally generic and reusable — the Item and Vendor "card" APIs (GetItemCard / GetVendorCard replacements) reuse the same buffer table and helper codeunit rather than each defining their own. This entity is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "label" "value" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| customerCardLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customerCardLine |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "label" "value" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}Exposes posted customer invoice entries (Cust. Ledger Entry, filtered to Document Type = Invoice) as a read-only OData v4 entity, nested under LSC Customer API as $expand=customerInvoices. Replaces the legacy RetailWebServices SOAP GetCustomerInvoices operation (codeunits LSCGetCustomerInvoicesUtils / LSCGetCustomerInvoices). Only invoice-type entries are returned — other ledger entry types (payments, credit memos, etc.) are out of scope for this endpoint; see the separate, broader LSC Customer Entries API for all entry types. The amount and remainingAmount fields are deliberately sourced from the LSC extension fields "LSC Amount Int" / "LSC Remaining Amount Int" rather than the base Amount / Remaining Amount FlowFields, for parity with the legacy SOAP operation''s unposted-POS-payment amount adjustment behavior — this is a deliberate parity choice, not an oversight. This release is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "postingDate" "documentNo" "description" "open" "dueDate" "amount" "remainingAmount" "currencyCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| customerInvoice-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customerInvoice |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "postingDate" "documentNo" "description" "open" "dueDate" "amount" "remainingAmount" "currencyCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| customer-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customer |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "postingDate" "documentNo" "description" "open" "dueDate" "amount" "remainingAmount" "currencyCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| customer-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customer |
| customerInvoice-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customerInvoice |
| $select | Array of strings unique Items Enum: "id" "entryNo" "customerNo" "postingDate" "documentNo" "description" "open" "dueDate" "amount" "remainingAmount" "currencyCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}Exposes Customer (table 18) master data — identity, contact, address, and the commercial attributes (price group, discount group, currency, VAT status) an external system needs to price and localise an order — as a read-only OData v4 entity. Replaces the legacy RetailWebServices SOAP Customer read (the generic GET_TABLE_DATA reflection read and the GetCustomer projection in GetCustomerXML) for Unified Commerce integrations such as LS Ecommerce. The nested customerInvoices part ($expand=customerInvoices) replaces the legacy SOAP GetCustomerInvoices operation, returning the customer''s posted invoice-type Cust. Ledger Entry records. This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API; customers are maintained through the LS Central back-office UI. The intended filter entry points are no, name, email, and phoneNo — plain scalar fields BC''s OData v4 stack filters natively via $filter. A future phase may add write support.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "name" "name2" "searchName" "email" "phoneNo" "mobilePhoneNo" "contact" "primaryContactNo" "address" "address2" "city" "postCode" "county" "countryRegionCode" "currencyCode" "languageCode" "customerPriceGroup" "customerDiscGroup" "pricesIncludingVAT" "vatRegistrationNo" "blocked" "lastModifiedDateTime" "dateCreated" "createdByUser" "externalId" "lscCustomerId" "reasonCode" "restrictionFunctionality" "printDocumentInvoice" "transactionLimit" "daytimePhoneNo" "houseApartmentNo" "retailCustomerGroup" "defaultWeight" "otherTenderInFinalizing" "amtChargedOnPOS" "postAsShipment" "inclIncExpOnSalesDoc" "amtChargedPosted" "amtChargedOnPOSInt" "amtChargedPostedInt" "balanceLCYInt" Select properties to be returned |
| $expand | Array of strings unique Items Value: "customerInvoices" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "name2": null,
- "searchName": null,
- "email": null,
- "phoneNo": null,
- "mobilePhoneNo": null,
- "contact": null,
- "primaryContactNo": null,
- "address": null,
- "address2": null,
- "city": null,
- "postCode": null,
- "county": null,
- "countryRegionCode": null,
- "currencyCode": null,
- "languageCode": null,
- "customerPriceGroup": null,
- "customerDiscGroup": null,
- "pricesIncludingVAT": null,
- "vatRegistrationNo": null,
- "blocked": "_x0020_",
- "lastModifiedDateTime": null,
- "dateCreated": null,
- "createdByUser": null,
- "externalId": null,
- "lscCustomerId": null,
- "reasonCode": null,
- "restrictionFunctionality": null,
- "printDocumentInvoice": null,
- "transactionLimit": null,
- "daytimePhoneNo": null,
- "houseApartmentNo": null,
- "retailCustomerGroup": null,
- "defaultWeight": null,
- "otherTenderInFinalizing": null,
- "amtChargedOnPOS": null,
- "postAsShipment": null,
- "inclIncExpOnSalesDoc": null,
- "amtChargedPosted": null,
- "amtChargedOnPOSInt": null,
- "amtChargedPostedInt": null,
- "balanceLCYInt": null,
- "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| customer-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of customer |
| $select | Array of strings unique Items Enum: "id" "no" "name" "name2" "searchName" "email" "phoneNo" "mobilePhoneNo" "contact" "primaryContactNo" "address" "address2" "city" "postCode" "county" "countryRegionCode" "currencyCode" "languageCode" "customerPriceGroup" "customerDiscGroup" "pricesIncludingVAT" "vatRegistrationNo" "blocked" "lastModifiedDateTime" "dateCreated" "createdByUser" "externalId" "lscCustomerId" "reasonCode" "restrictionFunctionality" "printDocumentInvoice" "transactionLimit" "daytimePhoneNo" "houseApartmentNo" "retailCustomerGroup" "defaultWeight" "otherTenderInFinalizing" "amtChargedOnPOS" "postAsShipment" "inclIncExpOnSalesDoc" "amtChargedPosted" "amtChargedOnPOSInt" "amtChargedPostedInt" "balanceLCYInt" Select properties to be returned |
| $expand | Array of strings unique Items Value: "customerInvoices" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "name2": null,
- "searchName": null,
- "email": null,
- "phoneNo": null,
- "mobilePhoneNo": null,
- "contact": null,
- "primaryContactNo": null,
- "address": null,
- "address2": null,
- "city": null,
- "postCode": null,
- "county": null,
- "countryRegionCode": null,
- "currencyCode": null,
- "languageCode": null,
- "customerPriceGroup": null,
- "customerDiscGroup": null,
- "pricesIncludingVAT": null,
- "vatRegistrationNo": null,
- "blocked": "_x0020_",
- "lastModifiedDateTime": null,
- "dateCreated": null,
- "createdByUser": null,
- "externalId": null,
- "lscCustomerId": null,
- "reasonCode": null,
- "restrictionFunctionality": null,
- "printDocumentInvoice": null,
- "transactionLimit": null,
- "daytimePhoneNo": null,
- "houseApartmentNo": null,
- "retailCustomerGroup": null,
- "defaultWeight": null,
- "otherTenderInFinalizing": null,
- "amtChargedOnPOS": null,
- "postAsShipment": null,
- "inclIncExpOnSalesDoc": null,
- "amtChargedPosted": null,
- "amtChargedOnPOSInt": null,
- "amtChargedPostedInt": null,
- "balanceLCYInt": null,
- "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}Exposes the legacy SOAP GetItemCard operation (LSCGetItemCard / LSCGetItemCardUtils codeunits) as a standalone, read-only OData v4 entity. This is a top-level lookup, not nested under another entity: a caller supplies the item to look up via the itemNo filter (e.g. GET .../itemCardLines?$filter=itemNo eq ''40180'') or, when itemNo is blank, via the barcodeNo filter — itemNo always wins when both are supplied, matching legacy precedence. variantCode narrows to one item variant (ignored when resolving by barcodeNo, where the variant instead comes from the barcode''s own variant); storeNo/locationCode scope the Inventory/Qty rows to a store or location; viewCode selects the response shape: blank or ''01'' returns the 7-row card (Item, Description, Variant Code[, Variant Description, Variant Description 2], Inventory, Qty in PO, Qty in SO, Qty inb. TO); ''02''/''03'' return a matrix lookup (a Dimension Value row plus one row per sibling variant, keyed by the other dimension) and never include Inventory/PO/SO/TO rows; any other viewCode returns an empty result set. barcodeNo, variantCode, storeNo, locationCode and viewCode are a verbatim echo of the request, not resolution output — they exist only so the platform''s $filter can match generated rows; itemNo is the exception and always holds the resolved item number. An unresolved item, barcode, variant, store or location is not an error condition — it simply returns an empty result set. A filter expression (wildcards, ranges, or/and operators) on any of these properties is treated as no criterion. Each row is a computed (label, value) pair built fresh on every request — this is not a persisted table, so there is no meaningful "last modified" timestamp for a row and lastModifiedDateTime is deliberately not exposed. The underlying "LSC WS Line Buffer" table (also used, unaffected, by several legacy SOAP web service codeunits) and its "Source No." extension field, together with "LSC Card Line Buffer Mgt", are the same shared, generic infrastructure the Customer Card API and Vendor Card API reuse rather than duplicating. This entity is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryNo" "itemNo" "label" "value" "barcodeNo" "variantCode" "storeNo" "locationCode" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "itemNo": null,
- "label": null,
- "value": null,
- "barcodeNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "viewCode": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCardLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCardLine |
| $select | Array of strings unique Items Enum: "id" "entryNo" "itemNo" "label" "value" "barcodeNo" "variantCode" "storeNo" "locationCode" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "itemNo": null,
- "label": null,
- "value": null,
- "barcodeNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "viewCode": null
}Read-only projection of Item Category codes and descriptions. Item Category is the standard Business Central classification table used across LS Central as the "Item Category Code" lookup target from many entities, most notably the LSC Retail Product Group (see the separate LSC Retail Product Group API, whose own categoryName field is a FlowField sourced from this same table via the assigned Item Category Code). This entity exists so a consumer can resolve or enumerate category codes/descriptions directly, without depending on a specific product group record. productGroups is a read-only, $expand-able child collection of the Retail Product Groups assigned to this item category; it nests one level further into productGroupItems (the Items in each group), so a caller can $expand=productGroups($expand=productGroupItems) to retrieve the full three-level tree in a single request.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroups" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCategory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCategory |
| $select | Array of strings unique Items Enum: "id" "code" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroups" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}Exposes Item (table 27) master data — identity, description, product grouping, and the LSC-specific retail attributes (product group, season, item family, scale item) needed for point-of-sale and catalog lookups — as a read-only OData v4 entity. Replaces the legacy RetailWebServices GET_TABLE_DATA read used by LS Omni''s ItemSearch(search) operation (GetGeneralWebRequestXML("Item", "Search Description", "search")). Microsoft''s own base-app "Item Entity" API (items, v2.0) is a compiled dependency this app does not reference and does not project the LSC-specific fields exposed here, so this is a purpose-built endpoint rather than an extension of that entity. searchDescription is filterable with OData $filter=contains(searchDescription,''...'') for free-text search parity with the legacy wildcard (search) semantics — this requires no special page code, since contains() is automatic OData v4 behavior on any exposed field. This release is read-only: Insert, Modify, and Delete are not supported over the API; items are maintained through the LS Central back-office UI.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "searchDescription" "productGroupCode" "itemCategoryCode" "salesUnitOfMeasure" "seasonCode" "itemFamilyCode" "scaleItem" "blocked" "grossWeight" "unitVolume" "unitsPerParcel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroup" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "searchDescription": null,
- "productGroupCode": null,
- "itemCategoryCode": null,
- "salesUnitOfMeasure": null,
- "seasonCode": null,
- "itemFamilyCode": null,
- "scaleItem": null,
- "blocked": null,
- "grossWeight": null,
- "unitVolume": null,
- "unitsPerParcel": null,
- "lastModifiedDateTime": null,
- "productGroup": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| item-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of item |
| $select | Array of strings unique Items Enum: "id" "no" "description" "searchDescription" "productGroupCode" "itemCategoryCode" "salesUnitOfMeasure" "seasonCode" "itemFamilyCode" "scaleItem" "blocked" "grossWeight" "unitVolume" "unitsPerParcel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroup" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "searchDescription": null,
- "productGroupCode": null,
- "itemCategoryCode": null,
- "salesUnitOfMeasure": null,
- "seasonCode": null,
- "itemFamilyCode": null,
- "scaleItem": null,
- "blocked": null,
- "grossWeight": null,
- "unitVolume": null,
- "unitsPerParcel": null,
- "lastModifiedDateTime": null,
- "productGroup": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
}Exposes VAT Posting Setup (table 325) master data — the VAT business/product posting group combination, VAT %, calculation type, VAT identifier, sales/purchase VAT accounts, and VAT clause — as a read-only OData v4 entity, replacing the legacy SOAP GetVATPostingSetup replication read. Legacy stays available unchanged for the 18-month coexistence window. This entity is NOT store- or distribution-scoped: the legacy operation itself performs no such filtering (it calls the shared replication helper with an empty store parameter, which disables all distribution filtering), and the base table has no store/location dimension — every VAT Posting Setup combination in the company is returned to any caller, matching legacy behavior exactly. Read-only: VAT posting setups are maintained through the LS Central back-office UI.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "vatBusPostingGroup" "vatProdPostingGroup" "vatPercent" "vatCalculationType" "vatIdentifier" "salesVatAccount" "purchaseVatAccount" "vatClauseCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "vatBusPostingGroup": null,
- "vatProdPostingGroup": null,
- "vatPercent": null,
- "vatCalculationType": "Normal_x0020_VAT",
- "vatIdentifier": null,
- "salesVatAccount": null,
- "purchaseVatAccount": null,
- "vatClauseCode": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| vatPostingSetup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of vatPostingSetup |
| $select | Array of strings unique Items Enum: "id" "vatBusPostingGroup" "vatProdPostingGroup" "vatPercent" "vatCalculationType" "vatIdentifier" "salesVatAccount" "purchaseVatAccount" "vatClauseCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "vatBusPostingGroup": null,
- "vatProdPostingGroup": null,
- "vatPercent": null,
- "vatCalculationType": "Normal_x0020_VAT",
- "vatIdentifier": null,
- "salesVatAccount": null,
- "purchaseVatAccount": null,
- "vatClauseCode": null,
- "lastModifiedDateTime": null
}Exposes the legacy SOAP GetVendorCard operation (LSCGetVendorCard / LSCGetVendorCardUtils codeunits) as a standalone, read-only OData v4 entity. This is a top-level lookup, not nested under another entity: a caller supplies the vendor to look up via the vendorNo filter, e.g. GET .../vendorCardLines?$filter=vendorNo eq ''10000''. An omitted or non-resolving vendorNo filter is not an error condition — it simply returns an empty result set. Each row is a computed (label, value) pair built fresh from a single Vendor record on every request — this is not a persisted table, so there is no meaningful "last modified" timestamp for a row and lastModifiedDateTime is deliberately not exposed. The 6 rows, their labels, and their order exactly match the legacy operation''s output: Vendor No, Name, Name 2, Phone No., Fax No., E-Mail. viewCode is a verbatim echo of the request, matching legacy''s View parameter: ''01'' against a resolving vendor returns zero rows (not an error — the vendor still resolved, the requested view simply has none); blank or any other value (legacy has no ''02''/''03'' branch here) returns the full 6-row dump. A viewCode filter expression is treated as no criterion. The underlying "LSC WS Line Buffer" table (also used, unaffected, by several legacy SOAP web service codeunits) and its "Source No." extension field, together with "LSC Card Line Buffer Mgt", are the same shared, generic infrastructure the Customer Card API reuses rather than duplicating. This entity is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryNo" "vendorNo" "label" "value" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "vendorNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| vendorCardLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of vendorCardLine |
| $select | Array of strings unique Items Enum: "id" "entryNo" "vendorNo" "label" "value" "viewCode" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "vendorNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}Exposes the languages configured for LS Central data translation — each row is a language code (linked to the Business Central Language table) whose translations may be maintained in LS Central. Provided as a read-only OData v4 entity replacing the generic RetailWebServices GET_TABLE_DATA read of table "LSC Data Translation Language". This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API; translation languages are maintained through the LS Central back-office UI. A future phase may add write support.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "languageCode" "languageName" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "languageCode": "string",
- "languageName": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dataTranslationLanguage-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dataTranslationLanguage |
| $select | Array of strings unique Items Enum: "id" "languageCode" "languageName" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "languageCode": "string",
- "languageName": null,
- "lastModifiedDateTime": null
}Exposes the feature-flag setup rows (table "LSC Feature Flags Setup") as a flat, standalone read-only OData v4 entity — each row is a Store No. / POS Terminal / Feature Flag combination with its Value. Replaces the per-terminal feature-flag lookup portion of the legacy RetailWebServices TerminalGetById SOAP call (GetGeneralWebRequestXML on "LSC Feature Flags Setup" filtered by POS Terminal). This entity does NOT implement fallback/precedence resolution: it is a plain projection of the setup table, one top-level call, no server-side merging. A row with a blank POS Terminal represents a store-level default, and a row with both Store No. and POS Terminal blank represents a global default; the consumer is responsible for querying all three levels and merging them client-side if that semantic is needed, mirroring the legacy caller''s own id + "|''" OR-blank pattern (for example: $filter=posTerminal eq ''X'' or posTerminal eq ''''). This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "posTerminal" "featureFlag" "value" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "posTerminal": null,
- "featureFlag": null,
- "value": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| posTerminalFeatureFlag-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of posTerminalFeatureFlag |
| $select | Array of strings unique Items Enum: "id" "storeNo" "posTerminal" "featureFlag" "value" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "posTerminal": null,
- "featureFlag": null,
- "value": null,
- "lastModifiedDateTime": null
}Read-only projection of Item Management (picking/receiving) documents, provided so a caller can locate a document and post it. Hosts the post bound action, which replaces the legacy SOAP operation IMDocumentPost: it confirms or posts the document identified by this entity''s id, using the terminalNo, requestType, postMethod and documentType supplied on the request. Unlike the legacy operation, which always returned HTTP 200 with a failure message embedded in the response body, post raises a real error - and therefore an HTTP 4xx/5xx status - when the underlying posting fails, so callers can rely on the HTTP status code rather than parsing the response body.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "no" "type" "status" "inventoryProcessStatus" "storeNo" "locationCode" "inventoryTerminalAssigned" "expectedDate" "referenceNo" "postedNo" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "no": null,
- "type": null,
- "status": null,
- "inventoryProcessStatus": null,
- "storeNo": null,
- "locationCode": null,
- "inventoryTerminalAssigned": null,
- "expectedDate": null,
- "referenceNo": null,
- "postedNo": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| inventoryDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of inventoryDocument |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "no" "type" "status" "inventoryProcessStatus" "storeNo" "locationCode" "inventoryTerminalAssigned" "expectedDate" "referenceNo" "postedNo" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "no": null,
- "type": null,
- "status": null,
- "inventoryProcessStatus": null,
- "storeNo": null,
- "locationCode": null,
- "inventoryTerminalAssigned": null,
- "expectedDate": null,
- "referenceNo": null,
- "postedNo": null
}Confirms or posts this Item Management document (Receive or Pick). Raises an error - and an HTTP 4xx/5xx status - if the underlying posting fails, instead of returning HTTP 200 with a failure message.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| inventoryDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of inventoryDocument |
Action parameters
| terminalNo | null or string |
| requestType | null or string |
| postMethod | null or string |
| documentType | null or string |
{- "terminalNo": null,
- "requestType": null,
- "postMethod": null,
- "documentType": null
}{- "error": {
- "code": "string",
- "message": "string",
- "target": null,
- "details": [
- {
- "code": "string",
- "message": "string",
- "target": null
}
], - "innerError": { }
}
}Exposes Inventory Terminal-Store (table "LSC Inventory Terminal-Store") — the mapping of an Inventory (handheld) terminal to the store it replicates against — as a read-only OData v4 entity. Replaces the legacy RetailWebServices SOAP ReplicateInvStores(termId) call (GetGeneralWebRequestXML("LSC Inventory Terminal-Store", "Terminal No.", termId)). storeName is the active "Store - Name" lookup field. This release is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "terminalNo" "store" "storeName" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "posTerminal" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalNo": null,
- "store": null,
- "storeName": null,
- "lastModifiedDateTime": null,
- "posTerminal": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| inventoryTerminalStore-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of inventoryTerminalStore |
| $select | Array of strings unique Items Enum: "id" "terminalNo" "store" "storeName" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "posTerminal" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalNo": null,
- "store": null,
- "storeName": null,
- "lastModifiedDateTime": null,
- "posTerminal": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
}Replaces the legacy SOAP operations GetInventoryMultiple, GetInventoryMultipleV2 and GetItemInventory with a single entity powered by the GetInventoryMultipleV2 sourcing-location engine. An itemNo filter is required; an omitted itemNo returns an empty result set, not an error. The row grain depends on the storeNo, locationCode and sourcingLocationAvailability filters supplied: storeNo set and sourcingLocationAvailability false returns one row per store, with inventory summed across the store''s own locations; locationCode set and sourcingLocationAvailability false returns one row per location; neither storeNo nor locationCode set returns one row per store for every store; storeNo set and sourcingLocationAvailability true rolls the store''s customer order sourcing locations up into the store row; locationCode set (with or without sourcingLocationAvailability) returns one row per location. inventory is the sourcing-location engine''s net availability figure (already reduced by quantity sold not posted and customer order reservations) - it does not apply the safety-stock and expected-inbound/outbound adjustments that the older GetInventoryMultiple (V1) operation applied, so quantities may differ from that operation''s results for consumers migrating from it. onHandInventory preserves the gross on-hand quantity that the legacy GetItemInventory operation reported as Inventory, and actualInventory preserves that operation''s exact actualInventory formula (onHandInventory minus qtySoldNotPosted minus coReservedQuantity). Querying inventories and itemInventories for the same item and store is expected to return different numbers - they are computed by different engines for different purposes.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "itemNo" "variantCode" "storeNo" "locationCode" "inventory" "onHandInventory" "qtySoldNotPosted" "coReservedQuantity" "actualInventory" "expectedStock" "reorderPoint" "baseUnitOfMeasure" "description" "leadTimeDays" "colour" "size" "style" "sourcingLocationAvailability" "stockDays" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "inventory": null,
- "onHandInventory": null,
- "qtySoldNotPosted": null,
- "coReservedQuantity": null,
- "actualInventory": null,
- "expectedStock": null,
- "reorderPoint": null,
- "baseUnitOfMeasure": null,
- "description": null,
- "leadTimeDays": null,
- "colour": null,
- "size": null,
- "style": null,
- "sourcingLocationAvailability": null,
- "stockDays": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemInventory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemInventory |
| $select | Array of strings unique Items Enum: "id" "itemNo" "variantCode" "storeNo" "locationCode" "inventory" "onHandInventory" "qtySoldNotPosted" "coReservedQuantity" "actualInventory" "expectedStock" "reorderPoint" "baseUnitOfMeasure" "description" "leadTimeDays" "colour" "size" "style" "sourcingLocationAvailability" "stockDays" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "inventory": null,
- "onHandInventory": null,
- "qtySoldNotPosted": null,
- "coReservedQuantity": null,
- "actualInventory": null,
- "expectedStock": null,
- "reorderPoint": null,
- "baseUnitOfMeasure": null,
- "description": null,
- "leadTimeDays": null,
- "colour": null,
- "size": null,
- "style": null,
- "sourcingLocationAvailability": null,
- "stockDays": null
}Exposes Mobile License Registration (table "LSC MobileLicenseRegistration") — the license key issued to a mobile app instance on a given POS terminal — as a read-only OData v4 entity. Replaces the legacy RetailWebServices SOAP TerminalGetLicense(termId, appId) call (GetGeneralWebRequestXML("LSC MobileLicenseRegistration", "Terminal ID", termId, "App ID", appId)). deviceUniqueId is projected for completeness even though the legacy call did not read it. This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "terminalId" "appId" "deviceUniqueId" "deviceLicenseKey" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalId": null,
- "appId": null,
- "deviceUniqueId": null,
- "deviceLicenseKey": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| mobileLicenseRegistration-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of mobileLicenseRegistration |
| $select | Array of strings unique Items Enum: "id" "terminalId" "appId" "deviceUniqueId" "deviceLicenseKey" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalId": null,
- "appId": null,
- "deviceUniqueId": null,
- "deviceLicenseKey": null,
- "lastModifiedDateTime": null
}Exposes Mobile PLU (table "LSC MobilePlu") — a page of items pre-generated for a mobile PLU (price look-up) list at a store — as a read-only OData v4 entity. Replaces the legacy RetailWebServices SOAP ItemPage(storeId, pageId, pageIndex) call (GetGeneralWebRequestXML("LSC MobilePlu", "Store Id", storeId, "Page Id", pageId, "Page Index", pageIndex)). The image blob is not projected; retailImageId identifies the image for a separate lookup. This release is read-only: Insert, Modify, and Delete are not supported over the API.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeId" "pageId" "pageIndex" "itemId" "description" "retailImageId" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeId": null,
- "pageId": null,
- "pageIndex": null,
- "itemId": null,
- "description": null,
- "retailImageId": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| mobilePlu-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of mobilePlu |
| $select | Array of strings unique Items Enum: "id" "storeId" "pageId" "pageIndex" "itemId" "description" "retailImageId" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeId": null,
- "pageId": null,
- "pageIndex": null,
- "itemId": null,
- "description": null,
- "retailImageId": null,
- "lastModifiedDateTime": null
}Endpoint used by the Mobile Inventory client to submit scanned Store Inventory Worksheet lines. Each POST is processed synchronously - barcode/item resolution, unit-of-measure handling, and worksheet header defaults are applied via the same server logic used by the legacy StoreInvTransSendV2 SOAP service. Use the completeTransaction bound action on the storeInventoryWorksheet entity to finalize a transaction.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "worksheetSeqNo" "lineNo" "transactionNo" "transactionLineNo" "itemNo" "barcode" "quantity" "unitOfMeasureCode" "variantCode" "competitorPrice" "areaCode" "serialNo" "lotNo" "expirationDate" "reasonCode" "endOfTransaction" "scanDateTime" "staffId" "resultLineNo" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
New navigation property
| id | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Specifies the unique system identifier of the buffer row for this submitted line. Read-only. Assigned automatically by the platform when the row is persisted. |
| lastModifiedDateTime | null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... Specifies the date and time when the buffer row was last modified. Read-only. Set automatically by the platform. |
| worksheetSeqNo | null or number <int32> [ -2147483648 .. 2147483647 ] Specifies the sequence number of the Store Inventory Worksheet this scanned line belongs to. Required. Must reference an existing worksheet on this store; submitting a non-existent value is rejected with a standard OData error. |
| lineNo | null or number <int32> [ -2147483648 .. 2147483647 ] Specifies the caller-supplied line number for the scanned line. Optional. The server assigns the persisted line''s final Line No. based on the target worksheet and returns it as resultLineNo. |
| transactionNo | null or string <= 20 characters Specifies the transaction number for this batch of scanned lines. Required. Must be unique per worksheet; the completeTransaction action operates on this value together with the worksheet. |
| transactionLineNo | null or number <int32> [ -2147483648 .. 2147483647 ] Specifies the position of this line within the transaction batch. Optional. Assigned by the client and used to correlate duplicate resubmissions before completion. |
| itemNo | null or string <= 20 characters Specifies the item number to record on the line. Optional when barcode is provided; required otherwise. When barcode is supplied it takes precedence over this value. |
| barcode | null or string <= 20 characters Specifies the scanned barcode used to resolve the item, variant, and unit of measure. Optional. When provided it takes precedence over itemNo; when blank, itemNo must identify the item. Resolution follows the same logic as the legacy mobile transaction import. |
| quantity | null or number <decimal> Specifies the quantity counted or captured on the scanned line, expressed in the given unit of measure. Required for positive-count worksheets. |
| unitOfMeasureCode | null or string <= 10 characters Specifies the unit of measure code that qualifies the quantity. Optional. When blank the worksheet''s default UoM is applied by the server during line processing. |
| variantCode | null or string <= 10 characters Specifies the item variant code for the scanned line. Optional. When provided it must be a valid variant of the resolved item. |
| competitorPrice | null or number <decimal> Specifies a captured competitor price for the item on the scanned line. Optional. Used by price-check worksheets. |
| areaCode | null or string <= 10 characters Specifies the counting area code for the scanned line. Required on Counting worksheets that have Use Area enabled; submitting a blank value under those conditions is rejected with a standard OData error. |
| serialNo | null or string <= 50 characters Specifies the serial number for the scanned item, when item tracking is used. Optional. |
| lotNo | null or string <= 50 characters Specifies the lot number for the scanned item, when item tracking is used. Optional. |
| expirationDate | null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... Specifies the expiration date for the scanned item, when item tracking is used. Optional. |
| reasonCode | null or string <= 10 characters Specifies a reason code describing why the line was captured, matching the reason-code table. Optional. |
| endOfTransaction | null or boolean Specifies whether the sending device marked this scanned line as the end-of-transaction batch. Captured for audit and SOAP-parity, but does NOT finalize the transaction on this API. Clients MUST call the completeTransaction bound action on the worksheet entity to mark the transaction Received. |
| scanDateTime | null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... Specifies the date and time when the scan was captured on the mobile device. Optional. Preserved on the persisted inventory line for audit purposes. |
| staffId | null or string <= 20 characters Specifies the identifier of the staff member who performed the scan. Optional. Preserved on the persisted inventory line for audit purposes. |
| resultLineNo | null or number <int32> [ -2147483648 .. 2147483647 ] Specifies the Line No. assigned to the persisted Store Inventory Line record after the server successfully processed this submission. Read-only. Returned in the POST response and can be used by the client to correlate submissions with the resulting inventory line. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| storeInventoryLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of storeInventoryLine |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "worksheetSeqNo" "lineNo" "transactionNo" "transactionLineNo" "itemNo" "barcode" "quantity" "unitOfMeasureCode" "variantCode" "competitorPrice" "areaCode" "serialNo" "lotNo" "expirationDate" "reasonCode" "endOfTransaction" "scanDateTime" "staffId" "resultLineNo" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}Read-only worksheet context for the Mobile Inventory client. Also hosts the completeTransaction bound action, which finalizes a set of scanned lines - it marks all lines with the given transactionNo as received.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "worksheetSeqNo" "description" "storeNo" "worksheetType" "useArea" "storeInvTransactionMaxLines" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "description": null,
- "storeNo": null,
- "worksheetType": "Purchase",
- "useArea": null,
- "storeInvTransactionMaxLines": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| storeInventoryWorksheet-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of storeInventoryWorksheet |
| $select | Array of strings unique Items Enum: "id" "lastModifiedDateTime" "worksheetSeqNo" "description" "storeNo" "worksheetType" "useArea" "storeInvTransactionMaxLines" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "description": null,
- "storeNo": null,
- "worksheetType": "Purchase",
- "useArea": null,
- "storeInvTransactionMaxLines": null
}Completes a scanned inventory transaction for the given transactionNo on this worksheet: marks all its lines as received. Errors if there are no lines to complete, or if the transaction is already received.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| storeInventoryWorksheet-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of storeInventoryWorksheet |
Action parameters
| transactionNo | null or string |
{- "transactionNo": null
}{- "error": {
- "code": "string",
- "message": "string",
- "target": null,
- "details": [
- {
- "code": "string",
- "message": "string",
- "target": null
}
], - "innerError": { }
}
}Exposes Date Schedule Lines as a read-only OData v4 entity, nested under the parent dateSchedules entity. Replaces the legacy SOAP GET_TABLE_DATA "LSC Date Schedule Line" call used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. dateScheduleId is a code-value foreign key into the parent dateSchedules entity (join on its code field, not its id) — id on this entity, and on every entity in this API, is reserved for SystemId. exclude marks whether the startingDate/endingDate period is excluded rather than included when the parent Date Schedule is evaluated for validity.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dateScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateScheduleLine |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| dateScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateScheduleLine |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| dateScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateScheduleLine |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}Exposes Date Schedules as a read-only OData v4 entity, replacing the legacy SOAP GET_TABLE_DATA "LSC Date Schedule" call used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. code is this table''s business key (field ID) — id on this entity, and on every entity in this API, is reserved for SystemId, so a consumer joining a validationScheduleLines.dateScheduleId value to a Date Schedule must match it against code, not id. mondays through sundays and validAllWeekdays project the weekday validity flags. The nested dateScheduleLines part replaces the per-schedule GET_TABLE_DATA "LSC Date Schedule Line" call and is reachable via $expand=dateScheduleLines; a Date Schedule with no lines is valid on any weekday it is flagged for, with no additional date restrictions.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "mondays" "tuesdays" "wednesdays" "thursdays" "fridays" "saturdays" "sundays" "validAllWeekdays" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "dateScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| dateSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateSchedule |
| dateScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dateScheduleLine |
| $select | Array of strings unique Items Enum: "id" "dateScheduleId" "lineNo" "startingDate" "endingDate" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}Exposes Retail Product Groups as an OData v4 entity, replacing the legacy RetailWebServices generic table read of Retail Product Group (which remains published, unchanged, for the duration of the coexistence window). This release is GET-only; itemCategoryCode and code are plain scalar fields that can be used in a $filter. items is a read-only, $expand-able child collection of the Items assigned to this group. Image links for this (or any) entity are retrieved via the separate LSC Retail Image Link API by filtering tableName eq ''LSC Retail Product Group'' and keyValue eq ''''.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCategory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCategory |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "itemCategoryCode" "code" "categoryName" "description" "shelfLabelDescription" "itemTemplateCode" "posMenuLink" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItems" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCategory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCategory |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| $select | Array of strings unique Items Enum: "id" "itemCategoryCode" "code" "categoryName" "description" "shelfLabelDescription" "itemTemplateCode" "posMenuLink" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItems" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| item-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of item |
| $select | Array of strings unique Items Enum: "id" "itemCategoryCode" "code" "categoryName" "description" "shelfLabelDescription" "itemTemplateCode" "posMenuLink" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItems" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "itemCategoryCode" "code" "categoryName" "description" "shelfLabelDescription" "itemTemplateCode" "posMenuLink" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItems" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| $select | Array of strings unique Items Enum: "id" "itemCategoryCode" "code" "categoryName" "description" "shelfLabelDescription" "itemTemplateCode" "posMenuLink" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItems" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}Read-only projection of the Items assigned to a Retail Product Group. This entity is reachable via $expand=items on the parent productGroups entity, or by a direct GET on this entity set filtered by itemCategoryCode/no.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCategory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCategory |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemCategory-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemCategory |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| productGroupItem-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroupItem |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| item-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of item |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| item-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of item |
| productGroupItem-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroupItem |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemWithBarcode-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemWithBarcode |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| productGroupItem-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroupItem |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| productGroup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroup |
| productGroupItem-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of productGroupItem |
| $select | Array of strings unique Items Enum: "id" "no" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}Exposes item sales information via item lookup — a focused OData endpoint for item-driven sales analytics, replacing the legacy ItemSalesInfo SOAP service. Consumers retrieve item sales metrics including last posting date, sale quantities, and period-based sales totals. This is a read-only, item-scoped projection; for comprehensive item information, use the LSC Item API (items entity).
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "itemNo" "description" "vendorNo" "purchUnitOfMeasure" "lastPostingDate" "lastSaleQuantity" "soldLast5Days" "soldLast6Days" "soldLast7Days" "soldYesterday" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "description": null,
- "vendorNo": null,
- "purchUnitOfMeasure": null,
- "lastPostingDate": null,
- "lastSaleQuantity": null,
- "soldLast5Days": null,
- "soldLast6Days": null,
- "soldLast7Days": null,
- "soldYesterday": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemSalesInfo-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemSalesInfo |
| $select | Array of strings unique Items Enum: "id" "itemNo" "description" "vendorNo" "purchUnitOfMeasure" "lastPostingDate" "lastSaleQuantity" "soldLast5Days" "soldLast6Days" "soldLast7Days" "soldYesterday" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "description": null,
- "vendorNo": null,
- "purchUnitOfMeasure": null,
- "lastPostingDate": null,
- "lastSaleQuantity": null,
- "soldLast5Days": null,
- "soldLast6Days": null,
- "soldLast7Days": null,
- "soldYesterday": null,
- "lastModifiedDateTime": null
}Exposes LSC Item Variant Registration (table 10001414) — the registered combination of variant dimensions for an item under a variant framework — as a read-only OData v4 entity. Replaces the legacy RetailWebServices VariantRegGetById(id, itemId) operation (GetGeneralWebRequestXML("Item Variant Registration", "Variant", id, "Item No.", itemId)). This release is read-only: Insert, Modify, and Delete are not supported over the API; item variant registrations are maintained through the LS Central back-office UI.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "itemNo" "variant" "frameworkCode" "variantDimension1" "variantDimension2" "variantDimension3" "variantDimension4" "variantDimension5" "variantDimension6" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variant": "string",
- "frameworkCode": null,
- "variantDimension1": null,
- "variantDimension2": null,
- "variantDimension3": null,
- "variantDimension4": null,
- "variantDimension5": null,
- "variantDimension6": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemVariantRegistration-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemVariantRegistration |
| $select | Array of strings unique Items Enum: "id" "itemNo" "variant" "frameworkCode" "variantDimension1" "variantDimension2" "variantDimension3" "variantDimension4" "variantDimension5" "variantDimension6" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variant": "string",
- "frameworkCode": null,
- "variantDimension1": null,
- "variantDimension2": null,
- "variantDimension3": null,
- "variantDimension4": null,
- "variantDimension5": null,
- "variantDimension6": null,
- "lastModifiedDateTime": null
}Exposes item data via barcode lookup — a focused OData endpoint for barcode-driven item discovery, replacing the legacy GetItemWithBarcode SOAP service. Consumers filter by barcodeNo to retrieve item master data including description, variant, and unit of measure. This is a read-only, barcode-scoped projection; for comprehensive item information, use the LSC Item API (items entity). A barcodeNo filter that does not match a stored barcode is resolved as a weight/price-embedded barcode when possible: qty and price are decoded from the barcode digits, and the row''s lastModifiedDateTime is blank since it was not read from a persisted record.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "barcodeNo" "itemNo" "description" "variantCode" "unitOfMeasure" "imageIds" "qty" "price" "itemHtml" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItem" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "barcodeNo": "string",
- "itemNo": "string",
- "description": null,
- "variantCode": null,
- "unitOfMeasure": null,
- "imageIds": null,
- "qty": null,
- "price": null,
- "itemHtml": null,
- "lastModifiedDateTime": null,
- "productGroupItem": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| itemWithBarcode-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of itemWithBarcode |
| $select | Array of strings unique Items Enum: "id" "barcodeNo" "itemNo" "description" "variantCode" "unitOfMeasure" "imageIds" "qty" "price" "itemHtml" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "productGroupItem" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "barcodeNo": "string",
- "itemNo": "string",
- "description": null,
- "variantCode": null,
- "unitOfMeasure": null,
- "imageIds": null,
- "qty": null,
- "price": null,
- "itemHtml": null,
- "lastModifiedDateTime": null,
- "productGroupItem": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
}Exposes offer HTML content per language as a read-only OData v4 entity, replacing the replication-style GetOfferHTML SOAP/OData read for consumers that only need current-state polling - this replacement covers the read path only, and the read side of legacy GetOfferHTML remains available unchanged for the duration of this coexistence window. Poll for new/updated offers with $filter=lastModifiedDateTime gt {cursor}&$orderby=lastModifiedDateTime; a full read is the same GET with no filter, paged via @odata.nextLink. Deletes are intentionally NOT visible through this entity - a GET is served directly from the source table, so a physically-deleted row can never appear, and Business Central has no OData $delta feed for custom API pages. There is no planned replacement for delete-tracking on this entity: consumers that need to detect deletions depend indefinitely on the legacy GetOfferHTML OData service (published as service ODataRequest, i.e. /ODataV4/ODataRequest_GetOfferHTML), calling it with fullRepl: false and reading the TableDataDel array of the response, with no expectation of it being retired. TableDataDel entries carry primary-key fields only (Offer No. and Language) - no url, no html - and TableDataDel is always empty when fullRepl is true. The underlying Html field is a BLOB and cannot be exposed directly on an API entity, so html is projected as a decoded UTF-8 text field, computed in memory per row from the Html BLOB. html is not a source-table field, so it is not filterable and not sortable - $filter and $orderby are not supported on it. The getContent bound action remains available for fetching a single offer''s HTML content as text. Because html dominates the payload size of each row, consumers polling large result sets should tune Prefer: odata.maxpagesize down to a smaller page size than they might use for other entities. Excluding html via $select reduces response payload size only - it does not reduce server-side processing cost, since html is computed for every returned row regardless of the projection. Consumers wanting a genuinely cheap key-enumeration pass should call the getContent action selectively for the rows they care about, rather than relying on $select against this entity for cost avoidance.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "offerNo" "language" "url" "html" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "offerNo": null,
- "language": null,
- "url": null,
- "html": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| offer-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of offer |
| $select | Array of strings unique Items Enum: "id" "offerNo" "language" "url" "html" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "offerNo": null,
- "language": null,
- "url": null,
- "html": null,
- "lastModifiedDateTime": null
}Returns the HTML content for this offer as plain text. The underlying Html field is a BLOB and cannot be exposed directly on the API entity, so this action is the supported way for partners to retrieve the offer''s HTML content.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| offer-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of offer |
{- "value": null
}Exposes the legacy SOAP LOAD_PUBLISHED_OFFER_ITEMS operation (ItemsGetByPublishedOfferId) as a standalone, read-only OData v4 entity. This is a top-level lookup, not nested under another entity: a caller supplies the published offer to look up via the publishedOfferNo filter, e.g. GET .../publishedOfferItems?$filter=publishedOfferNo eq ''PO0001''. publishedOfferNo is required - an omitted or non-resolving publishedOfferNo filter is not an error condition, it simply returns an empty result set. The legacy maxNoOfRows parameter is not exposed directly; use the OData-native $top instead, e.g. $top=50. totalNoOfEntries always carries the full, unfiltered count of items in the published offer, regardless of how many rows $top returns - it is not reduced by row limiting. Each row is computed fresh from the published offer''s current discount setup on every request - this is not a persisted table, so there is no meaningful "last modified" timestamp for a row and lastModifiedDateTime is deliberately not exposed. id is a per-request ephemeral identifier and is not stable across requests. This entity is read-only: Insert, Modify, and Delete are not supported over the API. The legacy SOAP LOAD_PUBLISHED_OFFER_ITEMS operation remains available unchanged.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "publishedOfferNo" "itemNo" "itemDescription" "imageId" "totalNoOfEntries" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "publishedOfferNo": null,
- "itemNo": null,
- "itemDescription": null,
- "imageId": null,
- "totalNoOfEntries": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| publishedOfferItem-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of publishedOfferItem |
| $select | Array of strings unique Items Enum: "id" "publishedOfferNo" "itemNo" "itemDescription" "imageId" "totalNoOfEntries" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "publishedOfferNo": null,
- "itemNo": null,
- "itemDescription": null,
- "imageId": null,
- "totalNoOfEntries": null
}Exposes Time Schedule Lines as a read-only OData v4 entity, nested under the parent timeSchedules entity. Replaces the legacy SOAP GET_TABLE_DATA "LSC Time Schedule Line" call used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. timeScheduleId is a code-value foreign key into the parent timeSchedules entity (join on its code field, not its id) — id on this entity, and on every entity in this API, is reserved for SystemId. period is a free-text name (not a code), unique only within a single Time Schedule — always filter/join on it together with timeScheduleId, never on period alone, and never build a synthetic key from it: this table has no Line No., its clustered key is (Time Schedule ID, Period), and entity addressing, paging and $expand all key off SystemId, never Period. The default row order returned is alphabetical by period (the clustered key order), not chronological; a consumer that needs periods in time order must sort on timeFrom itself. timeToIsPastMidnight is derived server-side from timeFrom/timeTo and reflects whether the period crosses midnight.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| timeScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeScheduleLine |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| timeScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeScheduleLine |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| timeScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeScheduleLine |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}Exposes Time Schedules as a read-only OData v4 entity, replacing the legacy SOAP GET_TABLE_DATA "LSC Time Schedule" call used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. code is this table''s business key (field ID, table Caption "Code") — id on this entity, and on every entity in this API, is reserved for SystemId, so a consumer joining a validationScheduleLines.timeScheduleId value to a Time Schedule must match it against code, not id. scheduleType is an extensible enum (Not Specified, Dining Hours, Validation Schedule); a satellite or customer extension can add values, so a consumer must tolerate unknown scheduleType strings rather than switch on an exhaustive list. The nested timeScheduleLines part replaces the per-schedule GET_TABLE_DATA "LSC Time Schedule Line" call and is reachable via $expand=timeScheduleLines; a Time Schedule with no lines is valid at any time.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "scheduleType" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| timeSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeSchedule |
| timeScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of timeScheduleLine |
| $select | Array of strings unique Items Enum: "id" "timeScheduleId" "period" "timeFrom" "timeTo" "timeToIsPastMidnight" "diningDurationCode" "selectedByDefault" "reservationIntervalMinutes" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "timeSchedule" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}Exposes Validation Periods as a read-only OData v4 entity, replacing the legacy SOAP/OData GetValidationPeriod service (codeunit "LSC Commerce Request Mgt") used by LS Omni; the legacy service remains published, unchanged, and available on an opt-in, per-client basis for an 18-month coexistence window — it is not obsoleted by this release. This release is GET-only; write verbs may be added to this same object in a later phase. code is this table''s business key (field ID) — id on this entity, and on every entity in this API, is reserved for SystemId. This entity is deliberately unscoped: the legacy GetValidationPeriod service itself applies no store, distribution, or price-group filtering (it calls its underlying lookup with a blank store number and returns every Validation Period record), so this replacement matches that behavior exactly rather than introducing scoping the legacy service never had. Each Validation Period defines an overall starting/ending date and time window plus per-weekday time windows (Monday through Sunday), each with its own "time within bounds" flag and "ending time after midnight" flag, and a separate offer starting/ending time pair.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "startingDate" "endingDate" "startingTime" "endingTime" "timeWithinBounds" "mondayStartingTime" "mondayEndingTime" "mondayTimeWithinBounds" "mondayEndingTimeAfterMidnight" "tuesdayStartingTime" "tuesdayEndingTime" "tuesdayTimeWithinBounds" "tuesdayEndingTimeAfterMidnight" "wednesdayStartingTime" "wednesdayEndingTime" "wednesdayTimeWithinBounds" "wednesdayEndingTimeAfterMidnight" "thursdayStartingTime" "thursdayEndingTime" "thursdayTimeWithinBounds" "thursdayEndingTimeAfterMidnight" "fridayStartingTime" "fridayEndingTime" "fridayTimeWithinBounds" "fridayEndingTimeAfterMidnight" "saturdayStartingTime" "saturdayEndingTime" "saturdayTimeWithinBounds" "saturdayEndingTimeAfterMidnight" "sundayStartingTime" "sundayEndingTime" "sundayTimeWithinBounds" "sundayEndingTimeAfterMidnight" "endingTimeAfterMidnight" "offerStartingTime" "offerEndingTime" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": null,
- "description": null,
- "startingDate": null,
- "endingDate": null,
- "startingTime": null,
- "endingTime": null,
- "timeWithinBounds": null,
- "mondayStartingTime": null,
- "mondayEndingTime": null,
- "mondayTimeWithinBounds": null,
- "mondayEndingTimeAfterMidnight": null,
- "tuesdayStartingTime": null,
- "tuesdayEndingTime": null,
- "tuesdayTimeWithinBounds": null,
- "tuesdayEndingTimeAfterMidnight": null,
- "wednesdayStartingTime": null,
- "wednesdayEndingTime": null,
- "wednesdayTimeWithinBounds": null,
- "wednesdayEndingTimeAfterMidnight": null,
- "thursdayStartingTime": null,
- "thursdayEndingTime": null,
- "thursdayTimeWithinBounds": null,
- "thursdayEndingTimeAfterMidnight": null,
- "fridayStartingTime": null,
- "fridayEndingTime": null,
- "fridayTimeWithinBounds": null,
- "fridayEndingTimeAfterMidnight": null,
- "saturdayStartingTime": null,
- "saturdayEndingTime": null,
- "saturdayTimeWithinBounds": null,
- "saturdayEndingTimeAfterMidnight": null,
- "sundayStartingTime": null,
- "sundayEndingTime": null,
- "sundayTimeWithinBounds": null,
- "sundayEndingTimeAfterMidnight": null,
- "endingTimeAfterMidnight": null,
- "offerStartingTime": null,
- "offerEndingTime": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationPeriod-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationPeriod |
| $select | Array of strings unique Items Enum: "id" "code" "description" "startingDate" "endingDate" "startingTime" "endingTime" "timeWithinBounds" "mondayStartingTime" "mondayEndingTime" "mondayTimeWithinBounds" "mondayEndingTimeAfterMidnight" "tuesdayStartingTime" "tuesdayEndingTime" "tuesdayTimeWithinBounds" "tuesdayEndingTimeAfterMidnight" "wednesdayStartingTime" "wednesdayEndingTime" "wednesdayTimeWithinBounds" "wednesdayEndingTimeAfterMidnight" "thursdayStartingTime" "thursdayEndingTime" "thursdayTimeWithinBounds" "thursdayEndingTimeAfterMidnight" "fridayStartingTime" "fridayEndingTime" "fridayTimeWithinBounds" "fridayEndingTimeAfterMidnight" "saturdayStartingTime" "saturdayEndingTime" "saturdayTimeWithinBounds" "saturdayEndingTimeAfterMidnight" "sundayStartingTime" "sundayEndingTime" "sundayTimeWithinBounds" "sundayEndingTimeAfterMidnight" "endingTimeAfterMidnight" "offerStartingTime" "offerEndingTime" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": null,
- "description": null,
- "startingDate": null,
- "endingDate": null,
- "startingTime": null,
- "endingTime": null,
- "timeWithinBounds": null,
- "mondayStartingTime": null,
- "mondayEndingTime": null,
- "mondayTimeWithinBounds": null,
- "mondayEndingTimeAfterMidnight": null,
- "tuesdayStartingTime": null,
- "tuesdayEndingTime": null,
- "tuesdayTimeWithinBounds": null,
- "tuesdayEndingTimeAfterMidnight": null,
- "wednesdayStartingTime": null,
- "wednesdayEndingTime": null,
- "wednesdayTimeWithinBounds": null,
- "wednesdayEndingTimeAfterMidnight": null,
- "thursdayStartingTime": null,
- "thursdayEndingTime": null,
- "thursdayTimeWithinBounds": null,
- "thursdayEndingTimeAfterMidnight": null,
- "fridayStartingTime": null,
- "fridayEndingTime": null,
- "fridayTimeWithinBounds": null,
- "fridayEndingTimeAfterMidnight": null,
- "saturdayStartingTime": null,
- "saturdayEndingTime": null,
- "saturdayTimeWithinBounds": null,
- "saturdayEndingTimeAfterMidnight": null,
- "sundayStartingTime": null,
- "sundayEndingTime": null,
- "sundayTimeWithinBounds": null,
- "sundayEndingTimeAfterMidnight": null,
- "endingTimeAfterMidnight": null,
- "offerStartingTime": null,
- "offerEndingTime": null,
- "lastModifiedDateTime": null
}Exposes Validation Schedule Lines as a read-only OData v4 entity, nested under the parent validationSchedules entity. Replaces the legacy SOAP GET_TABLE_DATA "LSC Validation Schedule Line" call (a per-schedule read) used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. dateScheduleId and timeScheduleId are code-value foreign keys into the separate dateSchedules and timeSchedules entities respectively (join on their code field, not their id) — id on this entity, and on every entity in this API, is reserved for SystemId. exclude reflects whether a matching Date Schedule on this line invalidates the Validation Schedule; a consumer reproducing the server''s validity evaluation client-side must honor it or it will compute "valid" where the server computes "invalid". The nested dateSchedule and timeSchedule parts resolve dateScheduleId/timeScheduleId into the same dateSchedules/timeSchedules entities also reachable standalone — nesting reuses that data rather than duplicating it, and each nested part carries its own dateScheduleLines/timeScheduleLines child, so $expand=validationScheduleLines($expand=dateSchedule($expand=dateScheduleLines),timeSchedule($expand=timeScheduleLines)) resolves the full validationSchedules -> lines -> date/time schedule -> schedule lines graph in one call instead of three chained requests. Because $expand inlines the linked schedule''s payload on every line that references it, a date/time schedule shared across many lines is repeated once per referencing line rather than fetched once — this is a per-request trade-off the client controls by choosing whether to $expand these parts. timeSchedule resolves to zero rows when a line''s Time Schedule ID is blank, which is always true for an Exclude = true line (see the exclude note above).
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "validationScheduleId" "lineNo" "description" "comment" "priority" "dateScheduleId" "timeScheduleId" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "validationSchedule" "dateSchedules" "timeSchedules" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $select | Array of strings unique Items Enum: "id" "validationScheduleId" "lineNo" "description" "comment" "priority" "dateScheduleId" "timeScheduleId" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "validationSchedule" "dateSchedules" "timeSchedules" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "validationScheduleId" "lineNo" "description" "comment" "priority" "dateScheduleId" "timeScheduleId" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "validationSchedule" "dateSchedules" "timeSchedules" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| validationScheduleLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationScheduleLine |
| $select | Array of strings unique Items Enum: "id" "validationScheduleId" "lineNo" "description" "comment" "priority" "dateScheduleId" "timeScheduleId" "exclude" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "validationSchedule" "dateSchedules" "timeSchedules" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}Exposes Validation Schedules as a read-only OData v4 entity, replacing the legacy SOAP GET_TABLE_DATA "LSC Validation Schedule" call used by LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. code is this table''s business key (field ID) — id on this entity, and on every entity in this API, is reserved for SystemId, so a consumer joining a hierarchyDates.validationScheduleId value to a Validation Schedule must match it against code, not id. The nested validationScheduleLines part replaces the per-schedule GET_TABLE_DATA "LSC Validation Schedule Line" call and is reachable via $expand=validationScheduleLines. A Validation Schedule with no lines is always valid; otherwise its lines are evaluated in order of priority (high to low) against their linked dateSchedules/timeSchedules to determine validity at a given date and time. validationScheduleLines in turn nests dateSchedule/timeSchedule parts, so the full graph down to each schedule''s own lines is reachable in a single call via $expand=validationScheduleLines($expand=dateSchedule($expand=dateScheduleLines),timeSchedule($expand=timeScheduleLines)).
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "validationScheduleLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": { },
- "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| validationSchedule-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of validationSchedule |
| $select | Array of strings unique Items Enum: "id" "code" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "validationScheduleLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": { },
- "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
]
}Replaces the legacy GetDataEntryBalanceV2 SOAP operation, as a new, separate, standalone OData v4 entity. Unlike voucherPinLookup (which is scoped to voucher entries specifically, resolved via a voucher number), this is a generic lookup over any LSC POS Data Entry by its own primary key - entryType and entryCode are both required as $filter values, e.g. GET .../dataEntryBalances?$filter=entryType eq ''VOUCHER'' and entryCode eq ''ABC123''. Both entryType and entryCode are required - an omitted entryType or entryCode filter is not an error, it simply returns an empty result set. The balance calculation mirrors the legacy operation exactly: for data entry types that create a voucher entry, the balance is the linked voucher''s own remaining amount; otherwise, an unapplied entry''s balance is its amount minus any amount already applied, and an applied entry''s balance is always zero. blockedOnECom and webStore are carried over from the entry''s own data entry type setup. A PIN gate matches the legacy operation''s own PIN check (LSC POS Data Entry.PIN) - but a wrong pin, a non-existent entryType/entryCode combination, and an omitted entryType/entryCode/pin all return the same empty result, deliberately, to avoid giving a caller an oracle to distinguish those cases, which is a stricter and safer posture than the legacy operation''s distinct 1010 ("not found")/1020 ("Incorrect Pin") response codes. The pin field is always 0 in every returned row, regardless of the pin filter value supplied, and never echoes anything meaningful. This entity is entirely read-only - Insert, Modify, and Delete are not supported. Known trade-off: because pin is supplied as a $filter value on a GET request, it appears in the request URL and may be captured by server access logs, request telemetry, or HTTP intermediary caches. This is an accepted trade-off for returning full, typed OData rows - a POST-based action could avoid URL exposure but can only return an opaque JSON blob on this platform, not real OData records, which was rejected as a design requirement for this entity. Confirm this instance''s logging and telemetry configuration excludes or redacts the pin query-string parameter before exposing this endpoint externally.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "entryType" "entryCode" "dataEntryBalance" "dataEntryExpiringDate" "blockedOnECom" "webStore" "pin" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryType": null,
- "entryCode": null,
- "dataEntryBalance": null,
- "dataEntryExpiringDate": null,
- "blockedOnECom": null,
- "webStore": null,
- "pin": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| dataEntryBalance-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of dataEntryBalance |
| $select | Array of strings unique Items Enum: "id" "entryType" "entryCode" "dataEntryBalance" "dataEntryExpiringDate" "blockedOnECom" "webStore" "pin" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryType": null,
- "entryCode": null,
- "dataEntryBalance": null,
- "dataEntryExpiringDate": null,
- "blockedOnECom": null,
- "webStore": null,
- "pin": null,
- "lastModifiedDateTime": null
}Exposes POS Terminal (table "LSC POS Terminal") setup — identity, terminal type, inventory and mobile-app parameters, and the resolved staff barcode logon requirement — as a read-only OData v4 entity. Replaces the legacy RetailWebServices SOAP TerminalGetById(id) call (GetGeneralWebRequestXML("LSC POS Terminal", "No.", id)). This release is read-only (Phase 1): Insert, Modify, and Delete are not supported over the API; POS terminals are maintained through the LS Central back-office UI. staffBarcodeLogon is a FlowField resolved from the terminal''s Functionality Profile (LSC POS Func. Profile."Staff Barcode Logon") and requires no separate lookup call.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| inventoryTerminalStore-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of inventoryTerminalStore |
| $select | Array of strings unique Items Enum: "id" "no" "description" "storeNo" "terminalType" "inventoryMainMenu" "inventoryNoOfRecords" "asnQuantityMethod" "itemFilteringMethod" "showNumberpad" "deviceType" "exitAfterEachTrans" "functionalityProfile" "staffBarcodeLogon" "idleTimeout" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "description" "storeNo" "terminalType" "inventoryMainMenu" "inventoryNoOfRecords" "asnQuantityMethod" "itemFilteringMethod" "showNumberpad" "deviceType" "exitAfterEachTrans" "functionalityProfile" "staffBarcodeLogon" "idleTimeout" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| posTerminal-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of posTerminal |
| $select | Array of strings unique Items Enum: "id" "no" "description" "storeNo" "terminalType" "inventoryMainMenu" "inventoryNoOfRecords" "asnQuantityMethod" "itemFilteringMethod" "showNumberpad" "deviceType" "exitAfterEachTrans" "functionalityProfile" "staffBarcodeLogon" "idleTimeout" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}Represents a tender type (payment method) configuration for a store, such as cash, cards, checks, vouchers, or member points, including POS behavior, rounding and amount limits, and posting accounts. This entity is read-only; create, update, and delete operations are not supported. The id field maps to the record''s SystemId, and lastModifiedDateTime maps to SystemModifiedAt, so consumers can use them for change tracking and polling.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "code" "storeNo" "description" "function" "validOnMobilePos" "scanQrCode" "noInTransaction" "changeTendCode" "aboveMinChangeTenderType" "minChange" "rounding" "roundingTo" "minAmountEntered" "maxAmountEntered" "minAmountAllowed" "maxAmountAllowed" "mayBeUsed" "managerKeyControl" "keyboardEntryAllowed" "overtenderAllowed" "overtenderMaxAmt" "undertenderAllowed" "returnMinusAllowed" "drawerOpens" "endorseCheck" "cardAccountNo" "askForDate" "seekAuthorization" "printSeparateInvoice" "frontOfCheck" "keyboardEntryRequired" "payAccountBill" "markingOnly" "foreignCurrency" "endorsementLine1" "endorsementLine2" "checkPayee" "slipBackInPrinter" "askForCardAccount" "invoiceInPrinter" "slipFrontInPrinter" "changeLineOnReceipt" "posCountEntries" "takenToBank" "countingRequired" "floatAllowed" "multiplyInTenderOperations" "accountType" "accountNo" "accountName" "chargePercent" "chargeToAccountNo" "differenceGlAcc" "lastDateModified" "refundGlAccountNo" "refundDirectly" "compressPaymEntries" "printInCidReport" "posPickupWarningAmount" "bankAccountType" "bankAccountNo" "bankAccountName" "bankDiffGlAcc" "takenToSafe" "posPickupWarningText" "countByDenominations" "removeFloatType" "fastClosingMethod" "excludeCoinsToBank" "toBankByDenom" "toSafeByDenom" "fixedFloatByDenom" "useBagsForBank" "bankBagsNoType" "bankBagsNos" "useBagsForSafe" "safeBagsNoType" "safeBagsNos" "fixedFloat" "useBagsForFixedFloat" "fixedFloatBagsNoType" "fixedFloatBagsNos" "outboundCode" "wicTenderType" "foodStamp" "autoAccountPaymentTender" "doNotPost" "groupSeparatelyFromCurrency" "systemCreatedAt" "systemCreatedBy" "lastModifiedDateTime" "systemModifiedBy" Select properties to be returned |
| $expand | Array of strings unique Items Value: "store" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "storeNo": "string",
- "description": null,
- "function": "Normal",
- "validOnMobilePos": null,
- "scanQrCode": null,
- "noInTransaction": null,
- "changeTendCode": null,
- "aboveMinChangeTenderType": null,
- "minChange": null,
- "rounding": null,
- "roundingTo": null,
- "minAmountEntered": null,
- "maxAmountEntered": null,
- "minAmountAllowed": null,
- "maxAmountAllowed": null,
- "mayBeUsed": null,
- "managerKeyControl": null,
- "keyboardEntryAllowed": null,
- "overtenderAllowed": null,
- "overtenderMaxAmt": null,
- "undertenderAllowed": null,
- "returnMinusAllowed": null,
- "drawerOpens": null,
- "endorseCheck": null,
- "cardAccountNo": null,
- "askForDate": null,
- "seekAuthorization": null,
- "printSeparateInvoice": null,
- "frontOfCheck": null,
- "keyboardEntryRequired": null,
- "payAccountBill": null,
- "markingOnly": null,
- "foreignCurrency": null,
- "endorsementLine1": null,
- "endorsementLine2": null,
- "checkPayee": null,
- "slipBackInPrinter": null,
- "askForCardAccount": null,
- "invoiceInPrinter": null,
- "slipFrontInPrinter": null,
- "changeLineOnReceipt": null,
- "posCountEntries": null,
- "takenToBank": null,
- "countingRequired": null,
- "floatAllowed": null,
- "multiplyInTenderOperations": null,
- "accountType": "G_x002F_L_x0020_Account",
- "accountNo": null,
- "accountName": null,
- "chargePercent": null,
- "chargeToAccountNo": null,
- "differenceGlAcc": null,
- "lastDateModified": null,
- "refundGlAccountNo": null,
- "refundDirectly": null,
- "compressPaymEntries": null,
- "printInCidReport": null,
- "posPickupWarningAmount": null,
- "bankAccountType": null,
- "bankAccountNo": null,
- "bankAccountName": null,
- "bankDiffGlAcc": null,
- "takenToSafe": null,
- "posPickupWarningText": null,
- "countByDenominations": null,
- "removeFloatType": null,
- "fastClosingMethod": null,
- "excludeCoinsToBank": null,
- "toBankByDenom": null,
- "toSafeByDenom": null,
- "fixedFloatByDenom": null,
- "useBagsForBank": null,
- "bankBagsNoType": null,
- "bankBagsNos": null,
- "useBagsForSafe": null,
- "safeBagsNoType": null,
- "safeBagsNos": null,
- "fixedFloat": null,
- "useBagsForFixedFloat": null,
- "fixedFloatBagsNoType": null,
- "fixedFloatBagsNos": null,
- "outboundCode": null,
- "wicTenderType": null,
- "foodStamp": null,
- "autoAccountPaymentTender": null,
- "doNotPost": null,
- "groupSeparatelyFromCurrency": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "lastModifiedDateTime": null,
- "systemModifiedBy": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| tenderType-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of tenderType |
| $select | Array of strings unique Items Enum: "id" "code" "storeNo" "description" "function" "validOnMobilePos" "scanQrCode" "noInTransaction" "changeTendCode" "aboveMinChangeTenderType" "minChange" "rounding" "roundingTo" "minAmountEntered" "maxAmountEntered" "minAmountAllowed" "maxAmountAllowed" "mayBeUsed" "managerKeyControl" "keyboardEntryAllowed" "overtenderAllowed" "overtenderMaxAmt" "undertenderAllowed" "returnMinusAllowed" "drawerOpens" "endorseCheck" "cardAccountNo" "askForDate" "seekAuthorization" "printSeparateInvoice" "frontOfCheck" "keyboardEntryRequired" "payAccountBill" "markingOnly" "foreignCurrency" "endorsementLine1" "endorsementLine2" "checkPayee" "slipBackInPrinter" "askForCardAccount" "invoiceInPrinter" "slipFrontInPrinter" "changeLineOnReceipt" "posCountEntries" "takenToBank" "countingRequired" "floatAllowed" "multiplyInTenderOperations" "accountType" "accountNo" "accountName" "chargePercent" "chargeToAccountNo" "differenceGlAcc" "lastDateModified" "refundGlAccountNo" "refundDirectly" "compressPaymEntries" "printInCidReport" "posPickupWarningAmount" "bankAccountType" "bankAccountNo" "bankAccountName" "bankDiffGlAcc" "takenToSafe" "posPickupWarningText" "countByDenominations" "removeFloatType" "fastClosingMethod" "excludeCoinsToBank" "toBankByDenom" "toSafeByDenom" "fixedFloatByDenom" "useBagsForBank" "bankBagsNoType" "bankBagsNos" "useBagsForSafe" "safeBagsNoType" "safeBagsNos" "fixedFloat" "useBagsForFixedFloat" "fixedFloatBagsNoType" "fixedFloatBagsNos" "outboundCode" "wicTenderType" "foodStamp" "autoAccountPaymentTender" "doNotPost" "groupSeparatelyFromCurrency" "systemCreatedAt" "systemCreatedBy" "lastModifiedDateTime" "systemModifiedBy" Select properties to be returned |
| $expand | Array of strings unique Items Value: "store" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "storeNo": "string",
- "description": null,
- "function": "Normal",
- "validOnMobilePos": null,
- "scanQrCode": null,
- "noInTransaction": null,
- "changeTendCode": null,
- "aboveMinChangeTenderType": null,
- "minChange": null,
- "rounding": null,
- "roundingTo": null,
- "minAmountEntered": null,
- "maxAmountEntered": null,
- "minAmountAllowed": null,
- "maxAmountAllowed": null,
- "mayBeUsed": null,
- "managerKeyControl": null,
- "keyboardEntryAllowed": null,
- "overtenderAllowed": null,
- "overtenderMaxAmt": null,
- "undertenderAllowed": null,
- "returnMinusAllowed": null,
- "drawerOpens": null,
- "endorseCheck": null,
- "cardAccountNo": null,
- "askForDate": null,
- "seekAuthorization": null,
- "printSeparateInvoice": null,
- "frontOfCheck": null,
- "keyboardEntryRequired": null,
- "payAccountBill": null,
- "markingOnly": null,
- "foreignCurrency": null,
- "endorsementLine1": null,
- "endorsementLine2": null,
- "checkPayee": null,
- "slipBackInPrinter": null,
- "askForCardAccount": null,
- "invoiceInPrinter": null,
- "slipFrontInPrinter": null,
- "changeLineOnReceipt": null,
- "posCountEntries": null,
- "takenToBank": null,
- "countingRequired": null,
- "floatAllowed": null,
- "multiplyInTenderOperations": null,
- "accountType": "G_x002F_L_x0020_Account",
- "accountNo": null,
- "accountName": null,
- "chargePercent": null,
- "chargeToAccountNo": null,
- "differenceGlAcc": null,
- "lastDateModified": null,
- "refundGlAccountNo": null,
- "refundDirectly": null,
- "compressPaymEntries": null,
- "printInCidReport": null,
- "posPickupWarningAmount": null,
- "bankAccountType": null,
- "bankAccountNo": null,
- "bankAccountName": null,
- "bankDiffGlAcc": null,
- "takenToSafe": null,
- "posPickupWarningText": null,
- "countByDenominations": null,
- "removeFloatType": null,
- "fastClosingMethod": null,
- "excludeCoinsToBank": null,
- "toBankByDenom": null,
- "toSafeByDenom": null,
- "fixedFloatByDenom": null,
- "useBagsForBank": null,
- "bankBagsNoType": null,
- "bankBagsNos": null,
- "useBagsForSafe": null,
- "safeBagsNoType": null,
- "safeBagsNos": null,
- "fixedFloat": null,
- "useBagsForFixedFloat": null,
- "fixedFloatBagsNoType": null,
- "fixedFloatBagsNos": null,
- "outboundCode": null,
- "wicTenderType": null,
- "foodStamp": null,
- "autoAccountPaymentTender": null,
- "doNotPost": null,
- "groupSeparatelyFromCurrency": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "lastModifiedDateTime": null,
- "systemModifiedBy": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
}Replicates the PIN gate enforced by the legacy GetVoucherEntriesV2 SOAP operation, as a new, separate, standalone OData v4 entity - the existing vouchers entity (LSC Voucher API) is not modified by this and remains the permission-gated, non-PIN, back-office/bulk read path over the same LSC Voucher Entries table. A caller must supply both voucherNo and pin as $filter values, e.g. GET .../voucherPinLookups?$filter=voucherNo eq ''VOU0001'' and pin eq 1234. voucherNo is required - an omitted voucherNo filter is not an error, it simply returns an empty result set. The gate mirrors the legacy operation exactly: it looks up the LSC POS Data Entry matched by (voucherType, voucherNo) from the resolved voucher''s own Voucher Type - if no such POS Data Entry exists, there is no gate at all (open access, matching legacy behavior), and all matching voucher entries are returned regardless of pin. If a POS Data Entry does exist, its PIN must equal the supplied pin filter (0 if pin is omitted) or the result is an empty set. A wrong pin, a non-existent voucherNo, and an omitted voucherNo/pin all return the same empty result - deliberately, to avoid giving a caller an oracle to distinguish those three cases, which is a stricter and safer posture than the legacy operation''s distinct 1020 ("No entries exist")/1030 ("Incorrect Pin") response codes. The response shape is the same 18 fields as the vouchers entity plus id and lastModifiedDateTime, plus a pin field that is always 0 - so pin is not response data, it is a gate condition only: the pin field is always 0 in every returned row, regardless of the pin filter value supplied, and never echoes anything meaningful. entryType is exposed as a language-dependent string carrying the option''s caption text (Issued/Redemption), same as the vouchers entity, because the underlying field is an AL Option, not an Enum. This entity is entirely read-only - Insert, Modify, and Delete are not supported. Known trade-off: because pin is supplied as a $filter value on a GET request, it appears in the request URL and may be captured by server access logs, request telemetry, or HTTP intermediary caches. This is an accepted trade-off for returning full, typed OData rows in the same shape as the vouchers entity - a POST-based action could avoid URL exposure but can only return an opaque JSON blob on this platform, not real OData records, which was rejected as a design requirement for this entity. Confirm this instance''s logging and telemetry configuration excludes or redacts the pin query-string parameter before exposing this endpoint externally.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "voucherNo" "storeNo" "posTerminalNo" "transactionNo" "lineNo" "receiptNumber" "unposted" "entryType" "date" "time" "amount" "voided" "remainingAmountNow" "oneTimeRedemption" "voucherType" "currencyCode" "currencyFactor" "amountInStoreCurrency" "pin" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "pin": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| voucherPinLookup-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of voucherPinLookup |
| $select | Array of strings unique Items Enum: "id" "voucherNo" "storeNo" "posTerminalNo" "transactionNo" "lineNo" "receiptNumber" "unposted" "entryType" "date" "time" "amount" "voided" "remainingAmountNow" "oneTimeRedemption" "voucherType" "currencyCode" "currencyFactor" "amountInStoreCurrency" "pin" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "pin": null,
- "lastModifiedDateTime": null
}Exposes LSC Voucher Entries — the transaction-level ledger of voucher/gift-card issue and redemption entries — as an OData v4 entity, replacing the legacy SOAP operations GetVoucherEntries, GetVoucherEntriesV2, and SendVoucherEntry (all three remain available unchanged for the duration of the coexistence window). GET performs a plain read of the source table with no server-side business logic; always filter with $filter=voucherNo eq ''...'' — this is indexed on the table''s Voucher No./Entry Type/Voided key — because an unfiltered GET enumerates the entire transactional table under standard OData paging. The legacy GetVoucherEntriesV2 operation additionally required a PIN validated against the linked LSC POS Data Entry before returning entries; this API deliberately drops that check and relies on standard OData permission-set gating instead (page execute + tabledata grant) — an accepted, documented parity gap versus the legacy read. entryType is exposed as a language-dependent string carrying the option''s caption text (Issued/Redemption) — confirmed via a live $metadata request against this published entity, which renders it as Edm.String with an IsLanguageDependent annotation, not an OData Edm.Enum, because the table''s underlying field is an AL Option, not an Enum. Three legacy table fields are intentionally not exposed on this entity: Replication Counter (internal distribution bookkeeping, assigned automatically on insert), Write Off Amount, and Store Currency Code — no consumer need was identified for this release. POST creates a voucher entry and reproduces the single side effect of the legacy SendVoucherEntry operation: when the linked LSC POS Data Entry (matched by voucherType/voucherNo) has a Voucher Remaining Amount of exactly zero after the insert, that data entry is marked Applied. Three behaviors are deliberate divergences from the legacy SendVoucherEntry SOAP operation, not defects: (1) every bound field is validated on write (e.g. storeNo and currencyCode are checked against their table relations), where the legacy operation performed a raw, unvalidated field assignment — a POST with an unknown store or currency now errors instead of silently persisting a dangling code; (2) this entity is insert-only — a POST whose primary key (storeNo/posTerminalNo/transactionNo/lineNo/receiptNumber) collides with an existing row returns a duplicate-key error, where the legacy operation silently overwrote (upserted) the existing row; callers needing update semantics should expect a PATCH in a future release, not a mutating POST; (3) Replication Counter is assigned on insert because table triggers run (Insert(true)), whereas the legacy operation deliberately skipped it (Insert(false) — a store pushing up to head office); an OData caller is treated as a back-office/integration client whose new rows must flow out to stores on the next delta replication.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "voucherNo" "storeNo" "posTerminalNo" "transactionNo" "lineNo" "receiptNumber" "unposted" "entryType" "date" "time" "amount" "voided" "remainingAmountNow" "oneTimeRedemption" "voucherType" "currencyCode" "currencyFactor" "amountInStoreCurrency" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
New navigation property
| id | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... |
| voucherNo | null or string <= 20 characters |
| storeNo | null or string <= 10 characters |
| posTerminalNo | null or string <= 10 characters |
| transactionNo | null or number <int32> [ -2147483648 .. 2147483647 ] |
| lineNo | null or number <int32> [ -2147483648 .. 2147483647 ] |
| receiptNumber | null or string <= 20 characters |
| unposted | null or boolean |
| entryType | null or string |
| date | null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... |
| time | null or string |
| amount | null or number <decimal> |
| voided | null or boolean |
| remainingAmountNow | null or number <decimal> |
| oneTimeRedemption | null or boolean |
| voucherType | null or string <= 10 characters |
| currencyCode | null or string <= 10 characters |
| currencyFactor | null or number <decimal> |
| amountInStoreCurrency | null or number <decimal> |
| lastModifiedDateTime | null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| voucher-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of voucher |
| $select | Array of strings unique Items Enum: "id" "voucherNo" "storeNo" "posTerminalNo" "transactionNo" "lineNo" "receiptNumber" "unposted" "entryType" "date" "time" "amount" "voided" "remainingAmountNow" "oneTimeRedemption" "voucherType" "currencyCode" "currencyFactor" "amountInStoreCurrency" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}Exposes Retail Image Links as an OData v4 entity — the generic, entity-agnostic way to retrieve the images linked to ANY record in the system, not just Retail Product Group. Consumers filter by tableName (the owning table''s real AL object name, e.g. tableName eq ''LSC Retail Product Group'') and keyValue (the owning record''s primary key field values, comma-joined in key-field order, e.g. for Retail Product Group, keyValue eq ''AUDIO,ACC'' for Item Category Code=AUDIO, Code=ACC). Retail Product Group''s own API (LSC Retail Product Group API) previously exposed a getImageLinks bound action for this purpose; that action has been removed and replaced by this standalone entity. This entity is GET-only.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "tableName" "keyValue" "imageId" "linkType" "displayOrder" "imageDescription" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tableName": null,
- "keyValue": null,
- "imageId": null,
- "linkType": "Image",
- "displayOrder": null,
- "imageDescription": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailImageLink-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailImageLink |
| $select | Array of strings unique Items Enum: "id" "tableName" "keyValue" "imageId" "linkType" "displayOrder" "imageDescription" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tableName": null,
- "keyValue": null,
- "imageId": null,
- "linkType": "Image",
- "displayOrder": null,
- "imageDescription": null,
- "lastModifiedDateTime": null
}Exposes ASN (Advance Shipping Notice) delivery document lines as a read-only OData v4 entity, replacing the legacy SOAP GetASNDocumentLines operation (18-month guaranteed coexistence). vendorTrustLevel is a live lookup to the parent document''s own Vendor Trust Level (not a stored line value), matching the legacy operation''s per-row lookup exactly. remainingQuantity mirrors the legacy operation''s own computed Ordered-vs-Delivered value.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "documentNo" "lineNo" "itemNo" "variantCode" "boxNo" "boxBarcodeNo" "remainingQuantity" "batchOrLotNo" "expirationDate" "vendorTrustLevel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| asnDocumentLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocumentLine |
| $select | Array of strings unique Items Enum: "id" "documentNo" "lineNo" "itemNo" "variantCode" "boxNo" "boxBarcodeNo" "remainingQuantity" "batchOrLotNo" "expirationDate" "vendorTrustLevel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| asnDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocument |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "documentNo" "lineNo" "itemNo" "variantCode" "boxNo" "boxBarcodeNo" "remainingQuantity" "batchOrLotNo" "expirationDate" "vendorTrustLevel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| asnDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocument |
| asnDocumentLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocumentLine |
| $select | Array of strings unique Items Enum: "id" "documentNo" "lineNo" "itemNo" "variantCode" "boxNo" "boxBarcodeNo" "remainingQuantity" "batchOrLotNo" "expirationDate" "vendorTrustLevel" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}Exposes ASN (Advance Shipping Notice) delivery documents as OData v4, replacing legacy SOAP GetASNDocumentList/GetASNDocumentLines/SendASNScannedLines (18-month guaranteed coexistence, legacy untouched). Read-only via GET; the submitScannedLines bound action replaces SendASNScannedLines exactly (same validation, duplicate-scan detection, and over-receipt handling as the legacy op — no business logic re-implemented, it delegates to the same underlying codeunit the SOAP endpoint uses). Document scannedLines JSON parameter shape: an array of objects with barcode, itemNo, variantCode, quantity, unitOfMeasureCode, expiryDate (ISO date), batchOrLotNumber — all optional except whichever combination resolves a line (either barcode, or itemNo+variantCode+unitOfMeasureCode). Errors (unknown barcode, duplicate box scan, item not in document) surface as a standard OData error with the same message text as the legacy op.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "documentNo" "vendorNo" "vendorName" "vendorTrustLevel" "estimatedArrivalDateTime" "manifestNo" "dispatchNo" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "asnDocumentLines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "vendorNo": null,
- "vendorName": null,
- "vendorTrustLevel": "_x0020_",
- "estimatedArrivalDateTime": null,
- "manifestNo": null,
- "dispatchNo": null,
- "lastModifiedDateTime": null,
- "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| asnDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocument |
| $select | Array of strings unique Items Enum: "id" "documentNo" "vendorNo" "vendorName" "vendorTrustLevel" "estimatedArrivalDateTime" "manifestNo" "dispatchNo" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "asnDocumentLines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "vendorNo": null,
- "vendorName": null,
- "vendorTrustLevel": "_x0020_",
- "estimatedArrivalDateTime": null,
- "manifestNo": null,
- "dispatchNo": null,
- "lastModifiedDateTime": null,
- "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}Submits a batch of scanned ASN lines (barcode/item scans during receiving). scannedLines is a JSON array of objects: barcode, itemNo, variantCode, quantity, unitOfMeasureCode, expiryDate, batchOrLotNumber. Errors on an unknown barcode, a duplicate box scan, or an item not found in this ASN document — identical validation to the legacy SendASNScannedLines SOAP operation.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| asnDocument-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of asnDocument |
Action parameters
| scannedLines | null or string |
{- "scannedLines": null
}{- "error": {
- "code": "string",
- "message": "string",
- "target": null,
- "details": [
- {
- "code": "string",
- "message": "string",
- "target": null
}
], - "innerError": { }
}
}Exposes which store is linked to which shared/group retail calendar for a given use type (e.g. Opening Hours) as a read-only OData v4 entity - a genuine table projection of LSC Rtl Calendar Group Linking, not a buffer. This is a different concept from the store-specific stores({id})?$expand=openingHours convenience: that surface resolves precedence automatically (a store''s own calendar overriding a group link) and returns the effective calendar, while this entity is for browsing the raw linkage data itself - which store points at which group calendar. Use $expand=retailCalendar to reach the linked calendar via the retailCalendars entity, and $expand=retailCalendar($expand=lines) to reach its lines in the same request via the lines entity nested there.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "useType" "calendarType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "retailCalendar" "retailCalendars" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": "string",
- "useType": "_x0020_",
- "calendarType": "All",
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}, - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $select | Array of strings unique Items Enum: "id" "storeNo" "useType" "calendarType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "retailCalendar" "retailCalendars" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": "string",
- "useType": "_x0020_",
- "calendarType": "All",
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}, - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}Exposes LS Central retail calendar headers (LSC Retail Calendar) as a general-purpose, read-only OData v4 entity for browsing calendars directly - a genuine table projection, not a buffer. This is a separate, standalone entity from the store-specific stores({id})?$expand=openingHours convenience: that surface returns a store''s effective calendar (accounting for store-vs-group precedence), while this entity is for browsing any calendar - group or store - directly, e.g. $filter=groupType eq ''Store'' and calendarId eq ''S0001'' and calendarType eq ''Opening Hours''. Use $expand=lines to read a calendar''s lines, or address the LSC Retail Calendar Line API entity independently.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "lines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "lines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "lines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "lines" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "description" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "store" "lines" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}Exposes the lines of a retail calendar (LSC Retail Calendar Line) as a read-only OData v4 entity. Reached either independently, filtered by calendarType/groupType/calendarId (e.g. $filter=groupType eq ''Store'' and calendarId eq ''S0001'' and calendarType eq ''Opening Hours''), or nested under its header: retailCalendars({id})?$expand=lines. This is a genuine table projection - no buffer, no procedural population - so dayName (a real FlowField on the underlying table) resolves automatically on read like any other field.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendarLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendarLine |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| retailCalendarLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendarLine |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendarLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendarLine |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| retailCalendarLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendarLine |
| $select | Array of strings unique Items Enum: "id" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "retailCalendar" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}Exposes LS Central store master data as a read-only OData v4 entity, replacing the legacy SOAP/OData GetStores operation for discovery and $filter/$expand scenarios. This release is GET-only; write verbs are planned for a later phase on the same entity. Use $expand=openingHours to read a store''s Retail Calendar Line data. Use the getDetail bound action to retrieve the full multi-table "Data Collection" graph (store, groups, price groups, sales types, and optionally sourcing locations, image links, attribute values, and calendar lines) exactly as legacy GetStores returns it - getDetail delegates to legacy GetStores unmodified, so its response is byte-identical to legacy for the same inputs, and can legitimately return stores other than the one it was called on when a broader storeGetType/searchText is supplied. Image bytes are not exposed here or by getDetail; see the separate retailImageLinks entity for image metadata. The legacy GetStores, GetStoreBuffer, and GetStoreOpeningHours SOAP/OData operations remain available unchanged.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| store-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of store |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}Returns the full multi-table store detail graph exactly as legacy GetStores returns it (byte-identical for the same inputs). includeDetail adds sourcing locations, image links, attribute values, and calendar lines. storeGetType must be one of: One, All, Click and Collect, Web Store, Search, Restaurants, Loyalty, Mobile - defaults to One when supplied blank/empty. searchText defaults to this store''s No. when supplied blank/empty; supplying a different value, or a broader storeGetType, can legitimately return other stores.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| store-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of store |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| tenderType-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of tenderType |
| $select | Array of strings unique Items Enum: "id" "no" "name" "address" "address2" "postCode" "city" "county" "countryCode" "latitude" "longitude" "phoneNo" "currencyCode" "functionalityProfile" "storeVatBusPostGr" "clickAndCollect" "loyalty" "webStore" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Items Value: "openingHours" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| tenderType-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of tenderType |
Action parameters
| includeDetail | null or boolean Default: false |
| storeGetType | null or string |
| searchText | null or string |
{- "includeDetail": false,
- "storeGetType": null,
- "searchText": null
}{- "value": null
}Exposes Retail Calendar Line data as a read-only part nested under a store (stores({id})?$expand=openingHours). Rows come from the store''s effective Opening Hours calendar — its own calendar if one is configured for the store, otherwise the calendar linked through its Retail Calendar Group — resolved directly against Retail Calendar Management, with no legacy service involved. A store with no calendar configured returns an empty set. This is not a persisted table — rows are computed fresh from the current calendar setup on every request, so id is a per-request ephemeral identifier and lastModifiedDateTime always reflects the time of the request rather than a stored value.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| calendarGroupLinking-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of calendarGroupLinking |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| retailCalendar-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of retailCalendar |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| store-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of store |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| store-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of store |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| tenderType-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of tenderType |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| tenderType-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of tenderType |
| openingHour-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of openingHour |
| $select | Array of strings unique Items Enum: "id" "storeNo" "calendarType" "groupType" "calendarId" "lineType" "startingDate" "endingDate" "dayNo" "dayName" "timeFrom" "timeTo" "midnightOpen" "includeAllWeekDays" "reasonClosed" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}Exposes LS Central hierarchy nodes with flexible filtering. The legacy GetHierarchyNode service remains available for 18 months (coexistence). Store scoping via storeCode filter (requires hierarchyCode filter; unknown store returns empty set). Prices (itemPriceInclTax/ExclTax) computed for Item-type links only; other types return zero. Item Category links are silently dropped under store/distribution scoping (see AboutText for store-scoping behavior details). Images: use retailImageLinks?$filter=tableName eq ''
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "type" "no" "description" "itemUnitOfMeasure" "sortOrder" "prepaymentPercent" "upsellingActive" "storeCode" "itemPriceInclTax" "itemPriceExclTax" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "prepaymentPercent": null,
- "upsellingActive": null,
- "storeCode": null,
- "itemPriceInclTax": null,
- "itemPriceExclTax": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchy-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchy |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "type" "no" "description" "itemUnitOfMeasure" "sortOrder" "prepaymentPercent" "upsellingActive" "storeCode" "itemPriceInclTax" "itemPriceExclTax" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "prepaymentPercent": null,
- "upsellingActive": null,
- "storeCode": null,
- "itemPriceInclTax": null,
- "itemPriceExclTax": null,
- "lastModifiedDateTime": null
}Returns a JSON graph of a hierarchy''s nodes (and, optionally, each node''s links) in presentation order, resolving the active hierarchy from the store/date/sales-type schedule when hierarchyCode is blank. The JSON always carries schemaVersion as its first key; the graph shape is additive-only within v1.0 - existing keys will not be renamed, removed or renested without a version bump.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchy-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchy |
Action parameters
| storeCode | null or string |
| hierarchyCode | null or string |
| atDateTime | null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|... |
| salesTypeFilter | null or string |
| includeLinks | null or boolean Default: false |
{- "storeCode": null,
- "hierarchyCode": null,
- "atDateTime": null,
- "salesTypeFilter": null,
- "includeLinks": false
}{- "value": null
}Exposes hierarchy data as a modern OData v4 endpoint, replacing the legacy SOAP/OData GetHierarchyV2 operation (LSCGetHierarchyV2 / LSCGetHierarchyV2Utils codeunits) for callers who want a single JSON payload instead of the legacy XML shape (the legacy service remains available unchanged for the duration of the coexistence window). The entity itself (hierarchyV2 / hierarchiesV2) is a read-only projection of the LSC Hierarchy table - Insert, Modify and Delete are not supported. All the real work happens through the getHierarchyV2 bound action, which takes no input: it returns, as plain text, a JSON document shaped { hierarchy: { code, description, type }, attributes: [ { code, description } ], attributeOptionValues: [ { code, sequence, optionValue } ], nodes: [ { code, nodeId, parentNodeId, description, indentation, presentationOrder, hasChildren } ], nodeImages: [ { keyValue, displayOrder, imageId } ] } - the same JSON shape the legacy operation returns, but for exactly the hierarchy the action is bound to. Because OData actions are always bound to an entity instance, calling getHierarchyV2 requires a hierarchiesV2(id) key in the URL, e.g. POST .../hierarchiesV2({id})/Microsoft.NAV.getHierarchyV2 - the id picked determines the response: the action returns only that hierarchy''s data, with no store lookup or "active hierarchy" resolution involved. Since the return type is a Text OData primitive rather than a nested object, the JSON document arrives as the escaped string value of the action response''s value property - callers must parse that string as JSON themselves. Because OData has already resolved the bound id to a real record before invoking the action, there is no "unknown id" error class for this action - the response is always HTTP 200, though attributes/nodes/nodeImages may legitimately be empty arrays for a hierarchy that has none.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "description" "type" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": "string",
- "description": null,
- "type": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyV2-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyV2 |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "description" "type" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": "string",
- "description": null,
- "type": null,
- "lastModifiedDateTime": null
}Returns the full GetHierarchyV2 payload (hierarchy, attributes, attributeOptionValues, nodes, nodeImages) for the bound hierarchy, as a JSON string. This is the OData v4 replacement for the legacy SOAP/OData GetHierarchyV2 operation. No input is required beyond the bound hierarchiesV2(id); attributes/nodes/nodeImages may legitimately be empty arrays.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyV2-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyV2 |
{- "value": null
}Exposes Hierarchy Dates as a read-only OData v4 entity, replacing the legacy SOAP GET_TABLE_DATA "LSC Hierar. Date" call that starts LS Omni''s ValidationScheduleGet chain; the legacy generic-table SOAP path remains published, unchanged, for the duration of the coexistence window. This release is GET-only. storeCode and priority are directly filterable/sortable scalar fields — filter on storeCode to resolve a store''s applicable entries, then pick the highest-priority row whose Validation Schedule (see the separate validationSchedules entity) is currently valid, optionally scoped further by hierarchyCode/salesTypeFilter. validationScheduleId is a code-value foreign key into the validationSchedules entity (join on its code field, not its id) — id on this entity is reserved for SystemId. This entity has no nested child part; there is no line/detail table for Hierarchy Date in this chain. hierarchyId is the SystemId of the corresponding hierarchiesV2 record, provided so callers can bind hierarchiesV2({id})/Microsoft.NAV.getHierarchyV2 on the sibling LSC GetHierarchyV2 API page without a separate lookup call.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "no" "storeCode" "priority" "validationScheduleId" "hierarchyId" "hierarchyCode" "salesTypeFilter" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "storeCode": null,
- "priority": null,
- "validationScheduleId": null,
- "hierarchyId": null,
- "hierarchyCode": null,
- "salesTypeFilter": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyDate-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyDate |
| $select | Array of strings unique Items Enum: "id" "no" "storeCode" "priority" "validationScheduleId" "hierarchyId" "hierarchyCode" "salesTypeFilter" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "storeCode": null,
- "priority": null,
- "validationScheduleId": null,
- "hierarchyId": null,
- "hierarchyCode": null,
- "salesTypeFilter": null,
- "lastModifiedDateTime": null
}Store-scoped, read-only projection of hierarchy links of Type = Deal, joined through their LSC Offer to LSC Deal Modifier Item lines, kept in sync in a real (non-temporary) buffer table, so id (SystemId) is stable across requests for the same hierarchyCode/nodeId/dealNo/offerLineNo/dealModifierLineNo/storeCode combination. This page replaces the removed legacy LSC Hierarchy Deal Line API query - use the storeCode filter (requires a hierarchyCode filter) to scope deal lines to a store''s price-group distribution, the same mechanism used by the hierarchies entity''s storeCode filter. Without a storeCode filter, all deal lines in the hierarchyCode/nodeId scope are returned. Rows that fall out of scope on a later read are actually deleted from the underlying buffer (not merely hidden), so this entity is webhook/change-tracking ready. There is no separate unscoped query anymore - omit the storeCode filter on this page for an unscoped read.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "dealNo" "offerLineNo" "dealModifierLineNo" "dealModifierCode" "itemNo" "description" "variantCode" "variantNeeded" "addedAmount" "unitOfMeasure" "qtyPerUnitOfMeasure" "maxItemSelection" "minSelection" "defaultSelection" "standardPrice" "standardPriceIncludingVAT" "itemDescription" "itemSalesUnitOfMeasure" "storeCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "dealNo": null,
- "offerLineNo": null,
- "dealModifierLineNo": null,
- "dealModifierCode": null,
- "itemNo": null,
- "description": null,
- "variantCode": null,
- "variantNeeded": null,
- "addedAmount": null,
- "unitOfMeasure": null,
- "qtyPerUnitOfMeasure": null,
- "maxItemSelection": null,
- "minSelection": null,
- "defaultSelection": null,
- "standardPrice": null,
- "standardPriceIncludingVAT": null,
- "itemDescription": null,
- "itemSalesUnitOfMeasure": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyDealLine-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyDealLine |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "dealNo" "offerLineNo" "dealModifierLineNo" "dealModifierCode" "itemNo" "description" "variantCode" "variantNeeded" "addedAmount" "unitOfMeasure" "qtyPerUnitOfMeasure" "maxItemSelection" "minSelection" "defaultSelection" "standardPrice" "standardPriceIncludingVAT" "itemDescription" "itemSalesUnitOfMeasure" "storeCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "dealNo": null,
- "offerLineNo": null,
- "dealModifierLineNo": null,
- "dealModifierCode": null,
- "itemNo": null,
- "description": null,
- "variantCode": null,
- "variantNeeded": null,
- "addedAmount": null,
- "unitOfMeasure": null,
- "qtyPerUnitOfMeasure": null,
- "maxItemSelection": null,
- "minSelection": null,
- "defaultSelection": null,
- "standardPrice": null,
- "standardPriceIncludingVAT": null,
- "itemDescription": null,
- "itemSalesUnitOfMeasure": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}Store-scoped, read-only projection of hierarchy links of Type = Deal, joined to their LSC Offer record and kept in sync in a real (non-temporary) buffer table, so id (SystemId) is stable across requests for the same hierarchyCode/nodeId/dealNo/storeCode combination. This page replaces the removed legacy LSC Hierarchy Deal List API query - use the storeCode filter (requires a hierarchyCode filter) to scope deals to a store''s price-group distribution, the same mechanism used by the hierarchies entity''s storeCode filter. Without a storeCode filter, all deals in the hierarchyCode/nodeId scope are returned. Rows that fall out of scope on a later read are actually deleted from the underlying buffer (not merely hidden), so this entity is webhook/change-tracking ready. There is no separate unscoped query anymore - omit the storeCode filter on this page for an unscoped read.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "sortOrder" "dealNo" "dealDescription" "status" "offerType" "priceGroup" "dealPrice" "startingDate" "endingDate" "validationPeriodId" "showDealLines" "dealModifiersExist" "storeCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "sortOrder": null,
- "dealNo": null,
- "dealDescription": null,
- "status": "Disabled",
- "offerType": "Promotion",
- "priceGroup": null,
- "dealPrice": null,
- "startingDate": null,
- "endingDate": null,
- "validationPeriodId": null,
- "showDealLines": null,
- "dealModifiersExist": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyDeal-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyDeal |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "sortOrder" "dealNo" "dealDescription" "status" "offerType" "priceGroup" "dealPrice" "startingDate" "endingDate" "validationPeriodId" "showDealLines" "dealModifiersExist" "storeCode" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "sortOrder": null,
- "dealNo": null,
- "dealDescription": null,
- "status": "Disabled",
- "offerType": "Promotion",
- "priceGroup": null,
- "dealPrice": null,
- "startingDate": null,
- "endingDate": null,
- "validationPeriodId": null,
- "showDealLines": null,
- "dealModifiersExist": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}Best-effort, read-only projection of hierarchy node links whose owning node has no children (leaf nodes), one row per link. This is a page rather than a query so that webhooks/actions can be added later without a redesign. There is no store scoping on this entity - use the hierarchies entity''s storeCode filter for a store-scoped read. A hierarchyCode filter is strongly recommended: without one this entity walks every leaf node in every hierarchy. The legacy GetHierarchyLeaf SOAP operation remains available, unretired, for delta-replication use cases (fullRepl/batchSize/lastKey), which this entity does not replicate. Performance: always filter by hierarchyCode to avoid full leaf-node enumeration. Unfiltered requests are O(n) where n is total leaf-count.
| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "nodeDescription" "type" "no" "description" "itemUnitOfMeasure" "sortOrder" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "nodeDescription": null,
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "lastModifiedDateTime": null
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| hierarchyLeaf-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of hierarchyLeaf |
| $select | Array of strings unique Items Enum: "id" "hierarchyCode" "nodeId" "nodeDescription" "type" "no" "description" "itemUnitOfMeasure" "sortOrder" "lastModifiedDateTime" Select properties to be returned |
| $expand | Array of strings unique Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "nodeDescription": null,
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "lastModifiedDateTime": null
}| $top | number <int64> >= 0 Example: $top=50 Show only the first n items |
| $skip | number <int64> >= 0 Skip the first n items |
| $search | string Search items by search phrases |
| $filter | string Filter items by property values |
| $count | boolean Include count of items |
| $orderby | Array of strings unique Order items by property values |
| $select | Array of strings unique Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "offers" "tenderTypes" "productGroupItems" "productGroups" "retailImageLinks" "itemCategories" "validationScheduleLines" "dateSchedules" "dateScheduleLines" "timeSchedules" "timeScheduleLines" "validationSchedules" "hierarchyDates" "dataEntryBalances" "openingHours" "stores" "retailCalendars" "lines" "calendarGroupLinkings" "asnDocumentLines" "validationPeriods" "asnDocuments" "hierarchies" "hierarchyLeaves" "storeInventoryLines" "vouchers" "voucherPinLookups" "storeInventoryWorksheets" "customers" "customerInvoices" "items" "currencies" "itemVariantRegistrations" "posTerminals" "posTerminalFeatureFlags" "mobileLicenseRegistrations" "customerCardLines" "vatPostingSetups" "mobilePlus" "inventoryTerminalStores" "publishedOfferItems" "vendorCardLines" "itemCardLines" "itemInventories" "inventoryDocuments" "itemWithBarcode" "dataTranslationLanguages" "hierarchiesV2" "hierarchyDeals" "hierarchyDealLines" "itemSalesInfo" Expand related entities |
{- "value": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "systemVersion": null,
- "timestamp": null,
- "name": null,
- "displayName": null,
- "businessProfileId": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "systemModifiedAt": null,
- "systemModifiedBy": null,
- "offers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "offerNo": null,
- "language": null,
- "url": null,
- "html": null,
- "lastModifiedDateTime": null
}
], - "tenderTypes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "storeNo": "string",
- "description": null,
- "function": "Normal",
- "validOnMobilePos": null,
- "scanQrCode": null,
- "noInTransaction": null,
- "changeTendCode": null,
- "aboveMinChangeTenderType": null,
- "minChange": null,
- "rounding": null,
- "roundingTo": null,
- "minAmountEntered": null,
- "maxAmountEntered": null,
- "minAmountAllowed": null,
- "maxAmountAllowed": null,
- "mayBeUsed": null,
- "managerKeyControl": null,
- "keyboardEntryAllowed": null,
- "overtenderAllowed": null,
- "overtenderMaxAmt": null,
- "undertenderAllowed": null,
- "returnMinusAllowed": null,
- "drawerOpens": null,
- "endorseCheck": null,
- "cardAccountNo": null,
- "askForDate": null,
- "seekAuthorization": null,
- "printSeparateInvoice": null,
- "frontOfCheck": null,
- "keyboardEntryRequired": null,
- "payAccountBill": null,
- "markingOnly": null,
- "foreignCurrency": null,
- "endorsementLine1": null,
- "endorsementLine2": null,
- "checkPayee": null,
- "slipBackInPrinter": null,
- "askForCardAccount": null,
- "invoiceInPrinter": null,
- "slipFrontInPrinter": null,
- "changeLineOnReceipt": null,
- "posCountEntries": null,
- "takenToBank": null,
- "countingRequired": null,
- "floatAllowed": null,
- "multiplyInTenderOperations": null,
- "accountType": "G_x002F_L_x0020_Account",
- "accountNo": null,
- "accountName": null,
- "chargePercent": null,
- "chargeToAccountNo": null,
- "differenceGlAcc": null,
- "lastDateModified": null,
- "refundGlAccountNo": null,
- "refundDirectly": null,
- "compressPaymEntries": null,
- "printInCidReport": null,
- "posPickupWarningAmount": null,
- "bankAccountType": null,
- "bankAccountNo": null,
- "bankAccountName": null,
- "bankDiffGlAcc": null,
- "takenToSafe": null,
- "posPickupWarningText": null,
- "countByDenominations": null,
- "removeFloatType": null,
- "fastClosingMethod": null,
- "excludeCoinsToBank": null,
- "toBankByDenom": null,
- "toSafeByDenom": null,
- "fixedFloatByDenom": null,
- "useBagsForBank": null,
- "bankBagsNoType": null,
- "bankBagsNos": null,
- "useBagsForSafe": null,
- "safeBagsNoType": null,
- "safeBagsNos": null,
- "fixedFloat": null,
- "useBagsForFixedFloat": null,
- "fixedFloatBagsNoType": null,
- "fixedFloatBagsNos": null,
- "outboundCode": null,
- "wicTenderType": null,
- "foodStamp": null,
- "autoAccountPaymentTender": null,
- "doNotPost": null,
- "groupSeparatelyFromCurrency": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "lastModifiedDateTime": null,
- "systemModifiedBy": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
}
], - "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
], - "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
], - "retailImageLinks": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tableName": null,
- "keyValue": null,
- "imageId": null,
- "linkType": "Image",
- "displayOrder": null,
- "imageDescription": null,
- "lastModifiedDateTime": null
}
], - "itemCategories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}
], - "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
], - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
], - "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
], - "validationSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": { },
- "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- null
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- null
]
}
]
}
]
}
], - "hierarchyDates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "storeCode": null,
- "priority": null,
- "validationScheduleId": null,
- "hierarchyId": null,
- "hierarchyCode": null,
- "salesTypeFilter": null,
- "lastModifiedDateTime": null
}
], - "dataEntryBalances": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryType": null,
- "entryCode": null,
- "dataEntryBalance": null,
- "dataEntryExpiringDate": null,
- "blockedOnECom": null,
- "webStore": null,
- "pin": null,
- "lastModifiedDateTime": null
}
], - "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
], - "stores": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
], - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
], - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
], - "calendarGroupLinkings": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": "string",
- "useType": "_x0020_",
- "calendarType": "All",
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}, - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": null,
- "storeNo": null,
- "calendarType": null,
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}
], - "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
], - "validationPeriods": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": null,
- "description": null,
- "startingDate": null,
- "endingDate": null,
- "startingTime": null,
- "endingTime": null,
- "timeWithinBounds": null,
- "mondayStartingTime": null,
- "mondayEndingTime": null,
- "mondayTimeWithinBounds": null,
- "mondayEndingTimeAfterMidnight": null,
- "tuesdayStartingTime": null,
- "tuesdayEndingTime": null,
- "tuesdayTimeWithinBounds": null,
- "tuesdayEndingTimeAfterMidnight": null,
- "wednesdayStartingTime": null,
- "wednesdayEndingTime": null,
- "wednesdayTimeWithinBounds": null,
- "wednesdayEndingTimeAfterMidnight": null,
- "thursdayStartingTime": null,
- "thursdayEndingTime": null,
- "thursdayTimeWithinBounds": null,
- "thursdayEndingTimeAfterMidnight": null,
- "fridayStartingTime": null,
- "fridayEndingTime": null,
- "fridayTimeWithinBounds": null,
- "fridayEndingTimeAfterMidnight": null,
- "saturdayStartingTime": null,
- "saturdayEndingTime": null,
- "saturdayTimeWithinBounds": null,
- "saturdayEndingTimeAfterMidnight": null,
- "sundayStartingTime": null,
- "sundayEndingTime": null,
- "sundayTimeWithinBounds": null,
- "sundayEndingTimeAfterMidnight": null,
- "endingTimeAfterMidnight": null,
- "offerStartingTime": null,
- "offerEndingTime": null,
- "lastModifiedDateTime": null
}
], - "asnDocuments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "vendorNo": null,
- "vendorName": null,
- "vendorTrustLevel": "_x0020_",
- "estimatedArrivalDateTime": null,
- "manifestNo": null,
- "dispatchNo": null,
- "lastModifiedDateTime": null,
- "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}
], - "hierarchies": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "prepaymentPercent": null,
- "upsellingActive": null,
- "storeCode": null,
- "itemPriceInclTax": null,
- "itemPriceExclTax": null,
- "lastModifiedDateTime": null
}
], - "hierarchyLeaves": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "nodeDescription": null,
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "lastModifiedDateTime": null
}
], - "storeInventoryLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}
], - "vouchers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}
], - "voucherPinLookups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "pin": null,
- "lastModifiedDateTime": null
}
], - "storeInventoryWorksheets": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "description": null,
- "storeNo": null,
- "worksheetType": "Purchase",
- "useArea": null,
- "storeInvTransactionMaxLines": null
}
], - "customers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "name2": null,
- "searchName": null,
- "email": null,
- "phoneNo": null,
- "mobilePhoneNo": null,
- "contact": null,
- "primaryContactNo": null,
- "address": null,
- "address2": null,
- "city": null,
- "postCode": null,
- "county": null,
- "countryRegionCode": null,
- "currencyCode": null,
- "languageCode": null,
- "customerPriceGroup": null,
- "customerDiscGroup": null,
- "pricesIncludingVAT": null,
- "vatRegistrationNo": null,
- "blocked": "_x0020_",
- "lastModifiedDateTime": null,
- "dateCreated": null,
- "createdByUser": null,
- "externalId": null,
- "lscCustomerId": null,
- "reasonCode": null,
- "restrictionFunctionality": null,
- "printDocumentInvoice": null,
- "transactionLimit": null,
- "daytimePhoneNo": null,
- "houseApartmentNo": null,
- "retailCustomerGroup": null,
- "defaultWeight": null,
- "otherTenderInFinalizing": null,
- "amtChargedOnPOS": null,
- "postAsShipment": null,
- "inclIncExpOnSalesDoc": null,
- "amtChargedPosted": null,
- "amtChargedOnPOSInt": null,
- "amtChargedPostedInt": null,
- "balanceLCYInt": null,
- "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}
], - "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
], - "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "searchDescription": null,
- "productGroupCode": null,
- "itemCategoryCode": null,
- "salesUnitOfMeasure": null,
- "seasonCode": null,
- "itemFamilyCode": null,
- "scaleItem": null,
- "blocked": null,
- "grossWeight": null,
- "unitVolume": null,
- "unitsPerParcel": null,
- "lastModifiedDateTime": null,
- "productGroup": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
}
], - "currencies": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "amountRoundingPrecision": null,
- "invoiceRoundingPrecision": null,
- "posCurrencySymbol": null,
- "placementOfCurrencySymbol": null,
- "invoiceRoundingType": null,
- "lastModifiedDateTime": null
}
], - "itemVariantRegistrations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variant": "string",
- "frameworkCode": null,
- "variantDimension1": null,
- "variantDimension2": null,
- "variantDimension3": null,
- "variantDimension4": null,
- "variantDimension5": null,
- "variantDimension6": null,
- "lastModifiedDateTime": null
}
], - "posTerminals": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
], - "posTerminalFeatureFlags": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "posTerminal": null,
- "featureFlag": null,
- "value": null,
- "lastModifiedDateTime": null
}
], - "mobileLicenseRegistrations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalId": null,
- "appId": null,
- "deviceUniqueId": null,
- "deviceLicenseKey": null,
- "lastModifiedDateTime": null
}
], - "customerCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
], - "vatPostingSetups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "vatBusPostingGroup": null,
- "vatProdPostingGroup": null,
- "vatPercent": null,
- "vatCalculationType": "Normal_x0020_VAT",
- "vatIdentifier": null,
- "salesVatAccount": null,
- "purchaseVatAccount": null,
- "vatClauseCode": null,
- "lastModifiedDateTime": null
}
], - "mobilePlus": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeId": null,
- "pageId": null,
- "pageIndex": null,
- "itemId": null,
- "description": null,
- "retailImageId": null,
- "lastModifiedDateTime": null
}
], - "inventoryTerminalStores": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalNo": null,
- "store": null,
- "storeName": null,
- "lastModifiedDateTime": null,
- "posTerminal": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
}
], - "publishedOfferItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "publishedOfferNo": null,
- "itemNo": null,
- "itemDescription": null,
- "imageId": null,
- "totalNoOfEntries": null
}
], - "vendorCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "vendorNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
], - "itemCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "itemNo": null,
- "label": null,
- "value": null,
- "barcodeNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "viewCode": null
}
], - "itemInventories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "inventory": null,
- "onHandInventory": null,
- "qtySoldNotPosted": null,
- "coReservedQuantity": null,
- "actualInventory": null,
- "expectedStock": null,
- "reorderPoint": null,
- "baseUnitOfMeasure": null,
- "description": null,
- "leadTimeDays": null,
- "colour": null,
- "size": null,
- "style": null,
- "sourcingLocationAvailability": null,
- "stockDays": null
}
], - "inventoryDocuments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "no": null,
- "type": null,
- "status": null,
- "inventoryProcessStatus": null,
- "storeNo": null,
- "locationCode": null,
- "inventoryTerminalAssigned": null,
- "expectedDate": null,
- "referenceNo": null,
- "postedNo": null
}
], - "itemWithBarcode": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "barcodeNo": "string",
- "itemNo": "string",
- "description": null,
- "variantCode": null,
- "unitOfMeasure": null,
- "imageIds": null,
- "qty": null,
- "price": null,
- "itemHtml": null,
- "lastModifiedDateTime": null,
- "productGroupItem": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
}
], - "dataTranslationLanguages": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "languageCode": "string",
- "languageName": null,
- "lastModifiedDateTime": null
}
], - "hierarchiesV2": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": "string",
- "description": null,
- "type": null,
- "lastModifiedDateTime": null
}
], - "hierarchyDeals": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "sortOrder": null,
- "dealNo": null,
- "dealDescription": null,
- "status": "Disabled",
- "offerType": "Promotion",
- "priceGroup": null,
- "dealPrice": null,
- "startingDate": null,
- "endingDate": null,
- "validationPeriodId": null,
- "showDealLines": null,
- "dealModifiersExist": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
], - "hierarchyDealLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "dealNo": null,
- "offerLineNo": null,
- "dealModifierLineNo": null,
- "dealModifierCode": null,
- "itemNo": null,
- "description": null,
- "variantCode": null,
- "variantNeeded": null,
- "addedAmount": null,
- "unitOfMeasure": null,
- "qtyPerUnitOfMeasure": null,
- "maxItemSelection": null,
- "minSelection": null,
- "defaultSelection": null,
- "standardPrice": null,
- "standardPriceIncludingVAT": null,
- "itemDescription": null,
- "itemSalesUnitOfMeasure": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
], - "itemSalesInfo": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "description": null,
- "vendorNo": null,
- "purchUnitOfMeasure": null,
- "lastPostingDate": null,
- "lastSaleQuantity": null,
- "soldLast5Days": null,
- "soldLast6Days": null,
- "soldLast7Days": null,
- "soldYesterday": null,
- "lastModifiedDateTime": null
}
]
}
]
}| company-id required | string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... The unique identifier of company |
| $select | Array of strings unique Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy" Select properties to be returned |
| $expand | Array of strings unique Items Enum: "offers" "tenderTypes" "productGroupItems" "productGroups" "retailImageLinks" "itemCategories" "validationScheduleLines" "dateSchedules" "dateScheduleLines" "timeSchedules" "timeScheduleLines" "validationSchedules" "hierarchyDates" "dataEntryBalances" "openingHours" "stores" "retailCalendars" "lines" "calendarGroupLinkings" "asnDocumentLines" "validationPeriods" "asnDocuments" "hierarchies" "hierarchyLeaves" "storeInventoryLines" "vouchers" "voucherPinLookups" "storeInventoryWorksheets" "customers" "customerInvoices" "items" "currencies" "itemVariantRegistrations" "posTerminals" "posTerminalFeatureFlags" "mobileLicenseRegistrations" "customerCardLines" "vatPostingSetups" "mobilePlus" "inventoryTerminalStores" "publishedOfferItems" "vendorCardLines" "itemCardLines" "itemInventories" "inventoryDocuments" "itemWithBarcode" "dataTranslationLanguages" "hierarchiesV2" "hierarchyDeals" "hierarchyDealLines" "itemSalesInfo" Expand related entities |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "systemVersion": null,
- "timestamp": null,
- "name": null,
- "displayName": null,
- "businessProfileId": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "systemModifiedAt": null,
- "systemModifiedBy": null,
- "offers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "offerNo": null,
- "language": null,
- "url": null,
- "html": null,
- "lastModifiedDateTime": null
}
], - "tenderTypes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "storeNo": "string",
- "description": null,
- "function": "Normal",
- "validOnMobilePos": null,
- "scanQrCode": null,
- "noInTransaction": null,
- "changeTendCode": null,
- "aboveMinChangeTenderType": null,
- "minChange": null,
- "rounding": null,
- "roundingTo": null,
- "minAmountEntered": null,
- "maxAmountEntered": null,
- "minAmountAllowed": null,
- "maxAmountAllowed": null,
- "mayBeUsed": null,
- "managerKeyControl": null,
- "keyboardEntryAllowed": null,
- "overtenderAllowed": null,
- "overtenderMaxAmt": null,
- "undertenderAllowed": null,
- "returnMinusAllowed": null,
- "drawerOpens": null,
- "endorseCheck": null,
- "cardAccountNo": null,
- "askForDate": null,
- "seekAuthorization": null,
- "printSeparateInvoice": null,
- "frontOfCheck": null,
- "keyboardEntryRequired": null,
- "payAccountBill": null,
- "markingOnly": null,
- "foreignCurrency": null,
- "endorsementLine1": null,
- "endorsementLine2": null,
- "checkPayee": null,
- "slipBackInPrinter": null,
- "askForCardAccount": null,
- "invoiceInPrinter": null,
- "slipFrontInPrinter": null,
- "changeLineOnReceipt": null,
- "posCountEntries": null,
- "takenToBank": null,
- "countingRequired": null,
- "floatAllowed": null,
- "multiplyInTenderOperations": null,
- "accountType": "G_x002F_L_x0020_Account",
- "accountNo": null,
- "accountName": null,
- "chargePercent": null,
- "chargeToAccountNo": null,
- "differenceGlAcc": null,
- "lastDateModified": null,
- "refundGlAccountNo": null,
- "refundDirectly": null,
- "compressPaymEntries": null,
- "printInCidReport": null,
- "posPickupWarningAmount": null,
- "bankAccountType": null,
- "bankAccountNo": null,
- "bankAccountName": null,
- "bankDiffGlAcc": null,
- "takenToSafe": null,
- "posPickupWarningText": null,
- "countByDenominations": null,
- "removeFloatType": null,
- "fastClosingMethod": null,
- "excludeCoinsToBank": null,
- "toBankByDenom": null,
- "toSafeByDenom": null,
- "fixedFloatByDenom": null,
- "useBagsForBank": null,
- "bankBagsNoType": null,
- "bankBagsNos": null,
- "useBagsForSafe": null,
- "safeBagsNoType": null,
- "safeBagsNos": null,
- "fixedFloat": null,
- "useBagsForFixedFloat": null,
- "fixedFloatBagsNoType": null,
- "fixedFloatBagsNos": null,
- "outboundCode": null,
- "wicTenderType": null,
- "foodStamp": null,
- "autoAccountPaymentTender": null,
- "doNotPost": null,
- "groupSeparatelyFromCurrency": null,
- "systemCreatedAt": null,
- "systemCreatedBy": null,
- "lastModifiedDateTime": null,
- "systemModifiedBy": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
}
], - "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
], - "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
], - "retailImageLinks": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tableName": null,
- "keyValue": null,
- "imageId": null,
- "linkType": "Image",
- "displayOrder": null,
- "imageDescription": null,
- "lastModifiedDateTime": null
}
], - "itemCategories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "productGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
]
}
], - "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- { }
]
}, - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
], - "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
], - "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- { }
]
}
}
], - "validationSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "validationScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "validationScheduleId": "string",
- "lineNo": null,
- "description": null,
- "comment": null,
- "priority": null,
- "dateScheduleId": null,
- "timeScheduleId": null,
- "exclude": null,
- "lastModifiedDateTime": null,
- "validationSchedule": { },
- "dateSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "mondays": null,
- "tuesdays": null,
- "wednesdays": null,
- "thursdays": null,
- "fridays": null,
- "saturdays": null,
- "sundays": null,
- "validAllWeekdays": null,
- "lastModifiedDateTime": null,
- "dateScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "dateScheduleId": "string",
- "lineNo": null,
- "startingDate": null,
- "endingDate": null,
- "exclude": null,
- "lastModifiedDateTime": null
}
]
}
], - "timeSchedules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "scheduleType": "Not_x0020_Specified",
- "lastModifiedDateTime": null,
- "timeScheduleLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "timeScheduleId": "string",
- "period": "string",
- "timeFrom": "string",
- "timeTo": "string",
- "timeToIsPastMidnight": null,
- "diningDurationCode": null,
- "selectedByDefault": null,
- "reservationIntervalMinutes": null,
- "lastModifiedDateTime": null,
- "timeSchedule": { }
}
]
}
]
}
]
}
], - "hierarchyDates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "storeCode": null,
- "priority": null,
- "validationScheduleId": null,
- "hierarchyId": null,
- "hierarchyCode": null,
- "salesTypeFilter": null,
- "lastModifiedDateTime": null
}
], - "dataEntryBalances": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryType": null,
- "entryCode": null,
- "dataEntryBalance": null,
- "dataEntryExpiringDate": null,
- "blockedOnECom": null,
- "webStore": null,
- "pin": null,
- "lastModifiedDateTime": null
}
], - "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
], - "stores": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}
], - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
], - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- { }
]
}
}
], - "calendarGroupLinkings": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": "string",
- "useType": "_x0020_",
- "calendarType": "All",
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "retailCalendar": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}, - "retailCalendars": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": "string",
- "description": null,
- "lastModifiedDateTime": null,
- "store": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "address": null,
- "address2": null,
- "postCode": null,
- "city": null,
- "county": null,
- "countryCode": null,
- "latitude": null,
- "longitude": null,
- "phoneNo": null,
- "currencyCode": null,
- "functionalityProfile": null,
- "storeVatBusPostGr": null,
- "clickAndCollect": null,
- "loyalty": null,
- "webStore": null,
- "lastModifiedDateTime": null,
- "openingHours": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null
}
]
}, - "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "calendarType": "All",
- "groupType": null,
- "calendarId": null,
- "lineType": null,
- "startingDate": null,
- "endingDate": null,
- "dayNo": null,
- "dayName": null,
- "timeFrom": null,
- "timeTo": null,
- "midnightOpen": null,
- "includeAllWeekDays": null,
- "reasonClosed": null,
- "lastModifiedDateTime": null,
- "retailCalendar": { }
}
]
}
]
}
], - "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
], - "validationPeriods": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": null,
- "description": null,
- "startingDate": null,
- "endingDate": null,
- "startingTime": null,
- "endingTime": null,
- "timeWithinBounds": null,
- "mondayStartingTime": null,
- "mondayEndingTime": null,
- "mondayTimeWithinBounds": null,
- "mondayEndingTimeAfterMidnight": null,
- "tuesdayStartingTime": null,
- "tuesdayEndingTime": null,
- "tuesdayTimeWithinBounds": null,
- "tuesdayEndingTimeAfterMidnight": null,
- "wednesdayStartingTime": null,
- "wednesdayEndingTime": null,
- "wednesdayTimeWithinBounds": null,
- "wednesdayEndingTimeAfterMidnight": null,
- "thursdayStartingTime": null,
- "thursdayEndingTime": null,
- "thursdayTimeWithinBounds": null,
- "thursdayEndingTimeAfterMidnight": null,
- "fridayStartingTime": null,
- "fridayEndingTime": null,
- "fridayTimeWithinBounds": null,
- "fridayEndingTimeAfterMidnight": null,
- "saturdayStartingTime": null,
- "saturdayEndingTime": null,
- "saturdayTimeWithinBounds": null,
- "saturdayEndingTimeAfterMidnight": null,
- "sundayStartingTime": null,
- "sundayEndingTime": null,
- "sundayTimeWithinBounds": null,
- "sundayEndingTimeAfterMidnight": null,
- "endingTimeAfterMidnight": null,
- "offerStartingTime": null,
- "offerEndingTime": null,
- "lastModifiedDateTime": null
}
], - "asnDocuments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "vendorNo": null,
- "vendorName": null,
- "vendorTrustLevel": "_x0020_",
- "estimatedArrivalDateTime": null,
- "manifestNo": null,
- "dispatchNo": null,
- "lastModifiedDateTime": null,
- "asnDocumentLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "documentNo": null,
- "lineNo": null,
- "itemNo": null,
- "variantCode": null,
- "boxNo": null,
- "boxBarcodeNo": null,
- "remainingQuantity": null,
- "batchOrLotNo": null,
- "expirationDate": null,
- "vendorTrustLevel": "_x0020_",
- "lastModifiedDateTime": null
}
]
}
], - "hierarchies": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "prepaymentPercent": null,
- "upsellingActive": null,
- "storeCode": null,
- "itemPriceInclTax": null,
- "itemPriceExclTax": null,
- "lastModifiedDateTime": null
}
], - "hierarchyLeaves": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": "string",
- "nodeDescription": null,
- "type": "Item",
- "no": null,
- "description": null,
- "itemUnitOfMeasure": null,
- "sortOrder": null,
- "lastModifiedDateTime": null
}
], - "storeInventoryLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "lineNo": null,
- "transactionNo": null,
- "transactionLineNo": null,
- "itemNo": null,
- "barcode": null,
- "quantity": null,
- "unitOfMeasureCode": null,
- "variantCode": null,
- "competitorPrice": null,
- "areaCode": null,
- "serialNo": null,
- "lotNo": null,
- "expirationDate": null,
- "reasonCode": null,
- "endOfTransaction": null,
- "scanDateTime": null,
- "staffId": null,
- "resultLineNo": null
}
], - "vouchers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "lastModifiedDateTime": null
}
], - "voucherPinLookups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "voucherNo": null,
- "storeNo": null,
- "posTerminalNo": null,
- "transactionNo": null,
- "lineNo": null,
- "receiptNumber": null,
- "unposted": null,
- "entryType": null,
- "date": null,
- "time": null,
- "amount": null,
- "voided": null,
- "remainingAmountNow": null,
- "oneTimeRedemption": null,
- "voucherType": null,
- "currencyCode": null,
- "currencyFactor": null,
- "amountInStoreCurrency": null,
- "pin": null,
- "lastModifiedDateTime": null
}
], - "storeInventoryWorksheets": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "worksheetSeqNo": null,
- "description": null,
- "storeNo": null,
- "worksheetType": "Purchase",
- "useArea": null,
- "storeInvTransactionMaxLines": null
}
], - "customers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "name": null,
- "name2": null,
- "searchName": null,
- "email": null,
- "phoneNo": null,
- "mobilePhoneNo": null,
- "contact": null,
- "primaryContactNo": null,
- "address": null,
- "address2": null,
- "city": null,
- "postCode": null,
- "county": null,
- "countryRegionCode": null,
- "currencyCode": null,
- "languageCode": null,
- "customerPriceGroup": null,
- "customerDiscGroup": null,
- "pricesIncludingVAT": null,
- "vatRegistrationNo": null,
- "blocked": "_x0020_",
- "lastModifiedDateTime": null,
- "dateCreated": null,
- "createdByUser": null,
- "externalId": null,
- "lscCustomerId": null,
- "reasonCode": null,
- "restrictionFunctionality": null,
- "printDocumentInvoice": null,
- "transactionLimit": null,
- "daytimePhoneNo": null,
- "houseApartmentNo": null,
- "retailCustomerGroup": null,
- "defaultWeight": null,
- "otherTenderInFinalizing": null,
- "amtChargedOnPOS": null,
- "postAsShipment": null,
- "inclIncExpOnSalesDoc": null,
- "amtChargedPosted": null,
- "amtChargedOnPOSInt": null,
- "amtChargedPostedInt": null,
- "balanceLCYInt": null,
- "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
]
}
], - "customerInvoices": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "postingDate": null,
- "documentNo": null,
- "description": null,
- "open": null,
- "dueDate": null,
- "amount": null,
- "remainingAmount": null,
- "currencyCode": null,
- "lastModifiedDateTime": null
}
], - "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "searchDescription": null,
- "productGroupCode": null,
- "itemCategoryCode": null,
- "salesUnitOfMeasure": null,
- "seasonCode": null,
- "itemFamilyCode": null,
- "scaleItem": null,
- "blocked": null,
- "grossWeight": null,
- "unitVolume": null,
- "unitsPerParcel": null,
- "lastModifiedDateTime": null,
- "productGroup": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemCategoryCode": "string",
- "code": "string",
- "categoryName": null,
- "description": null,
- "shelfLabelDescription": null,
- "itemTemplateCode": null,
- "posMenuLink": null,
- "lastModifiedDateTime": null,
- "productGroupItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
]
}
}
], - "currencies": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "code": "string",
- "description": null,
- "amountRoundingPrecision": null,
- "invoiceRoundingPrecision": null,
- "posCurrencySymbol": null,
- "placementOfCurrencySymbol": null,
- "invoiceRoundingType": null,
- "lastModifiedDateTime": null
}
], - "itemVariantRegistrations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variant": "string",
- "frameworkCode": null,
- "variantDimension1": null,
- "variantDimension2": null,
- "variantDimension3": null,
- "variantDimension4": null,
- "variantDimension5": null,
- "variantDimension6": null,
- "lastModifiedDateTime": null
}
], - "posTerminals": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
], - "posTerminalFeatureFlags": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeNo": null,
- "posTerminal": null,
- "featureFlag": null,
- "value": null,
- "lastModifiedDateTime": null
}
], - "mobileLicenseRegistrations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalId": null,
- "appId": null,
- "deviceUniqueId": null,
- "deviceLicenseKey": null,
- "lastModifiedDateTime": null
}
], - "customerCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "customerNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
], - "vatPostingSetups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "vatBusPostingGroup": null,
- "vatProdPostingGroup": null,
- "vatPercent": null,
- "vatCalculationType": "Normal_x0020_VAT",
- "vatIdentifier": null,
- "salesVatAccount": null,
- "purchaseVatAccount": null,
- "vatClauseCode": null,
- "lastModifiedDateTime": null
}
], - "mobilePlus": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "storeId": null,
- "pageId": null,
- "pageIndex": null,
- "itemId": null,
- "description": null,
- "retailImageId": null,
- "lastModifiedDateTime": null
}
], - "inventoryTerminalStores": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "terminalNo": null,
- "store": null,
- "storeName": null,
- "lastModifiedDateTime": null,
- "posTerminal": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "storeNo": "string",
- "terminalType": "POS_x0020_Terminal",
- "inventoryMainMenu": null,
- "inventoryNoOfRecords": null,
- "asnQuantityMethod": "_x0020_",
- "itemFilteringMethod": null,
- "showNumberpad": null,
- "deviceType": "Inactive",
- "exitAfterEachTrans": null,
- "functionalityProfile": null,
- "staffBarcodeLogon": null,
- "idleTimeout": null,
- "lastModifiedDateTime": null
}
}
], - "publishedOfferItems": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "publishedOfferNo": null,
- "itemNo": null,
- "itemDescription": null,
- "imageId": null,
- "totalNoOfEntries": null
}
], - "vendorCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "vendorNo": null,
- "label": null,
- "value": null,
- "viewCode": null
}
], - "itemCardLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "entryNo": null,
- "itemNo": null,
- "label": null,
- "value": null,
- "barcodeNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "viewCode": null
}
], - "itemInventories": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "variantCode": null,
- "storeNo": null,
- "locationCode": null,
- "inventory": null,
- "onHandInventory": null,
- "qtySoldNotPosted": null,
- "coReservedQuantity": null,
- "actualInventory": null,
- "expectedStock": null,
- "reorderPoint": null,
- "baseUnitOfMeasure": null,
- "description": null,
- "leadTimeDays": null,
- "colour": null,
- "size": null,
- "style": null,
- "sourcingLocationAvailability": null,
- "stockDays": null
}
], - "inventoryDocuments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedDateTime": null,
- "no": null,
- "type": null,
- "status": null,
- "inventoryProcessStatus": null,
- "storeNo": null,
- "locationCode": null,
- "inventoryTerminalAssigned": null,
- "expectedDate": null,
- "referenceNo": null,
- "postedNo": null
}
], - "itemWithBarcode": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "barcodeNo": "string",
- "itemNo": "string",
- "description": null,
- "variantCode": null,
- "unitOfMeasure": null,
- "imageIds": null,
- "qty": null,
- "price": null,
- "itemHtml": null,
- "lastModifiedDateTime": null,
- "productGroupItem": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "no": null,
- "description": null,
- "lastModifiedDateTime": null
}
}
], - "dataTranslationLanguages": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "languageCode": "string",
- "languageName": null,
- "lastModifiedDateTime": null
}
], - "hierarchiesV2": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": "string",
- "description": null,
- "type": null,
- "lastModifiedDateTime": null
}
], - "hierarchyDeals": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "sortOrder": null,
- "dealNo": null,
- "dealDescription": null,
- "status": "Disabled",
- "offerType": "Promotion",
- "priceGroup": null,
- "dealPrice": null,
- "startingDate": null,
- "endingDate": null,
- "validationPeriodId": null,
- "showDealLines": null,
- "dealModifiersExist": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
], - "hierarchyDealLines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "hierarchyCode": null,
- "nodeId": null,
- "dealNo": null,
- "offerLineNo": null,
- "dealModifierLineNo": null,
- "dealModifierCode": null,
- "itemNo": null,
- "description": null,
- "variantCode": null,
- "variantNeeded": null,
- "addedAmount": null,
- "unitOfMeasure": null,
- "qtyPerUnitOfMeasure": null,
- "maxItemSelection": null,
- "minSelection": null,
- "defaultSelection": null,
- "standardPrice": null,
- "standardPriceIncludingVAT": null,
- "itemDescription": null,
- "itemSalesUnitOfMeasure": null,
- "storeCode": null,
- "lastModifiedDateTime": null
}
], - "itemSalesInfo": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemNo": null,
- "description": null,
- "vendorNo": null,
- "purchUnitOfMeasure": null,
- "lastPostingDate": null,
- "lastSaleQuantity": null,
- "soldLast5Days": null,
- "soldLast6Days": null,
- "soldLast7Days": null,
- "soldYesterday": null,
- "lastModifiedDateTime": null
}
]
}