Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

Point-of-Sale Layouts

This API call let's you retrieve a detailed list of POS layouts. The response is an XML of the POS layouts.

Request Fields

Field Name Type Required Description
action String Yes poslayoutsView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control.

Response Fields

Field Name Type Description
posLayouts - XML structure
posLayout - XML structure
name String The POS name.
items - XML structure
item - XML structure
count Integer The product counter.
type String The item type (categore, brand, product).
id Integer The item ID.
payPageBackorder Integer 1 or 0. Whether the inventory can be backordered in the payment page.
orderView Integer 1 or 0. Whether the inventory can be viewed in the order.
orderUpdate Integer 1 or 0. Whether the inventory updates in the order.
orderBackorder Integer 1 or 0. Whether the inventory can be backordered in the order.
retailView Integer 1 or 0. Whether the inventory can be viewed in the retail POS.
retailUpdate Integer 1 or 0. Whether the inventory updates in the retail POS.
retailBackorder Integer 1 or 0. Whether the inventory can be backordered in the retail POS.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.

Response Code Error Code Message Description
0 - Invalid API Token1 The API Token is invalid, or not entered.
0 - Missing or Invalid Fields - Account ID The Account ID is invalid, or not entered.

Related Articles

Inventory Settings
Point-of-Sale Settings

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content