Skip to content

Articles (Products)

Endpoints for listing, creating, and updating article records.

GET /articles

List articles with optional filtering and pagination.

Request

GET /api/{account}/v4.0.0/articles
Authorization: Bearer <xa-token>

Parameters

Name In Type Required Description
nonce query integer (int64) No Client-generated unique sequential number
searchString query string No Search by article code
searchColumn query string No Column to search instead of the default field
searchOperator query string No Comparison operator: lt, lte, gt, gte, ne
options query string No Additional options for filtering or expanding the result set
skip query integer No Number of records to skip (pagination)
limit query integer No Max records to return. Max: 1000, default: 50

Tip

Use the options parameter to expand related data (e.g., stock levels, warehouse breakdown).

Responses

200 — Success

Returns an array of article objects (empty array if none found).

400 — Invalid input parameters

POST /articles

Add a new article to the system.

Request

POST /api/{account}/v4.0.0/articles?nonce={nonce}
Authorization: Bearer <xa-token>
Content-Type: application/json

Parameters

Name In Type Required Description
nonce query integer (int64) Yes Client-generated unique sequential number

Request Body

A article object.

{
  "item_code": "ART001",
  "description": "Widget Type A",
  "unit_price": 9.99,
  "sales_tax": 23.0
}

Responses

201 — Created

Returns an entityCreated object.

400 — Invalid input

Returns an apiError.

409 — Duplicate entry

PUT /articles

Update an existing article record.

Request

PUT /api/{account}/v4.0.0/articles?nonce={nonce}
Authorization: Bearer <xa-token>
Content-Type: application/json

Parameters

Name In Type Required Description
nonce query integer (int64) Yes Client-generated unique sequential number

Request Body

A article object with the id or identifying code of the record to update.

Responses

201 — Updated

400 — Invalid input

409 — Conflict

See Also