CycleCounts

cycleCounts

list InventoryCountImportView

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

statusDescriptionstringOptional

facilityNamestringOptional

closedDatestring · date-timeOptional

inventoryCountImportIdstringOptional

countImportNamestringOptional

countTypeEnumIdstringOptional

uploadedByUserLoginstringOptional

facilityIdstringOptional

parentCountIdstringOptional

statusIdstringOptional

createdDatestring · date-timeOptional

dueDatestring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.warehouse.InventoryCountImportView",
    "statusDescription": "text",
    "facilityName": "text",
    "closedDate": "2025-12-17T13:25:23.183Z",
    "inventoryCountImportId": "text",
    "countImportName": "text",
    "countTypeEnumId": "text",
    "uploadedByUserLogin": "text",
    "facilityId": "text",
    "parentCountId": "text",
    "statusId": "text",
    "createdDate": "2025-12-17T13:25:23.183Z",
    "dueDate": "2025-12-17T13:25:23.183Z"
  }
]

create InventoryCountImport

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: co.hotwax.warehouse.InventoryCountImport

inventoryCountImportIdstringOptional

countImportNamestringOptional

countTypeEnumIdstringOptional

uploadedByUserLoginstringOptional

facilityIdstringOptional

parentCountIdstringOptional

statusIdstringOptional

createdDatestring · date-timeOptional

dueDatestring · date-timeOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "_entity": "co.hotwax.warehouse.InventoryCountImport",
  "inventoryCountImportId": "text",
  "countImportName": "text",
  "countTypeEnumId": "text",
  "uploadedByUserLogin": "text",
  "facilityId": "text",
  "parentCountId": "text",
  "statusId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "dueDate": "2025-12-17T13:25:23.183Z",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "_entity": "co.hotwax.warehouse.InventoryCountImport.PK",
  "inventoryCountImportId": "text"
}

one InventoryCountImportView

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportView",
  "statusDescription": "text",
  "facilityName": "text",
  "closedDate": "2025-12-17T13:25:23.183Z",
  "inventoryCountImportId": "text",
  "countImportName": "text",
  "countTypeEnumId": "text",
  "uploadedByUserLogin": "text",
  "facilityId": "text",
  "parentCountId": "text",
  "statusId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "dueDate": "2025-12-17T13:25:23.183Z"
}

update InventoryCountImport

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: co.hotwax.warehouse.InventoryCountImport

inventoryCountImportIdstringOptional

countImportNamestringOptional

countTypeEnumIdstringOptional

uploadedByUserLoginstringOptional

facilityIdstringOptional

parentCountIdstringOptional

statusIdstringOptional

createdDatestring · date-timeOptional

dueDatestring · date-timeOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

put

/cycleCounts/{inventoryCountImportId}

HTTPcURLJavaScriptPython

PUT /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "_entity": "co.hotwax.warehouse.InventoryCountImport",
  "inventoryCountImportId": "text",
  "countImportName": "text",
  "countTypeEnumId": "text",
  "uploadedByUserLogin": "text",
  "facilityId": "text",
  "parentCountId": "text",
  "statusId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "dueDate": "2025-12-17T13:25:23.183Z",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "_entity": "co.hotwax.warehouse.InventoryCountImport.PK",
  "inventoryCountImportId": "text"
}

get InventoryCountImportItemDetails

get

Service to get Inventory Count Import Item details.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Query parameters

importItemSeqIdstringOptional

statusIdstringOptional

computeQOHstringOptional

orderBystringOptional

pageIndexinteger · int32Optional

The current page index to get the inventory count import items.

pageSizeinteger · int32Optional

The maximum number of inventory count import items to display.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}/items

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "itemList": []
}

one InventoryCountImportItem

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

importItemSeqIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportItem",
  "inventoryCountImportId": "text",
  "importItemSeqId": "text",
  "locationSeqId": "text",
  "statusId": "text",
  "productId": "text",
  "productIdentifier": "text",
  "quantity": 1,
  "countedByUserLoginId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "createdByUserLoginId": "text",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

update InventoryCountImportItem

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

importItemSeqIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: co.hotwax.warehouse.InventoryCountImportItem

inventoryCountImportIdstringOptional

importItemSeqIdstringOptional

locationSeqIdstringOptional

statusIdstringOptional

productIdstringOptional

productIdentifierstringOptional

quantitynumberOptional

countedByUserLoginIdstringOptional

createdDatestring · date-timeOptional

createdByUserLoginIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

put

/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}

HTTPcURLJavaScriptPython

PUT /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportItem",
  "inventoryCountImportId": "text",
  "importItemSeqId": "text",
  "locationSeqId": "text",
  "statusId": "text",
  "productId": "text",
  "productIdentifier": "text",
  "quantity": 1,
  "countedByUserLoginId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "createdByUserLoginId": "text",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportItem.PK",
  "inventoryCountImportId": "text",
  "importItemSeqId": "text"
}

delete InventoryCountImportItem

delete

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

importItemSeqIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}

HTTPcURLJavaScriptPython

DELETE /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

accept InventoryCountImportItem

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

importItemSeqIdstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportIdstringRequired

importItemSeqIdstringRequired

quantitystringOptional

systemQOHstringOptional

varianceQtystringOptional

reasonstringOptional

commentsstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}/accept

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}/accept HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "inventoryCountImportId": "text",
  "importItemSeqId": "text",
  "quantity": "text",
  "systemQOH": "text",
  "varianceQty": "text",
  "reason": "text",
  "comments": "text"
}

application/jsonmultipart/form-data

No content

list InventoryCountImportItem

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

importItemSeqIdstringOptional

locationSeqIdstringOptional

statusIdstringOptional

productIdstringOptional

productIdentifierstringOptional

quantitynumberOptional

countedByUserLoginIdstringOptional

createdDatestring · date-timeOptional

createdByUserLoginIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}/items/summary

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/summary HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.warehouse.InventoryCountImportItem",
    "inventoryCountImportId": "text",
    "importItemSeqId": "text",
    "locationSeqId": "text",
    "statusId": "text",
    "productId": "text",
    "productIdentifier": "text",
    "quantity": 1,
    "countedByUserLoginId": "text",
    "createdDate": "2025-12-17T13:25:23.183Z",
    "createdByUserLoginId": "text",
    "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
  }
]

add InventoryCountImportItems

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportIdstringRequired

itemListarrayOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/{inventoryCountImportId}/items/add

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/add HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "inventoryCountImportId": "text",
  "itemList": []
}

application/jsonmultipart/form-data

{
  "itemList": []
}

update InventoryCountImportItems

post

Service to update Inventory Count Import Item.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportIdstringRequired

itemListarrayRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/{inventoryCountImportId}/items/update

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/update HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "inventoryCountImportId": "text",
  "itemList": []
}

application/jsonmultipart/form-data

No content

recount InventoryCountImportItems

post

Service to recount Inventory Count Import Items.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportIdstringRequired

importItemSeqIdsarrayRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/{inventoryCountImportId}/items/recount

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/recount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "inventoryCountImportId": "text",
  "importItemSeqIds": []
}

application/jsonmultipart/form-data

No content

count InventoryCountImportItem

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: co.hotwax.warehouse.InventoryCountImportItem

inventoryCountImportIdstringOptional

importItemSeqIdstringOptional

locationSeqIdstringOptional

statusIdstringOptional

productIdstringOptional

productIdentifierstringOptional

quantitynumberOptional

countedByUserLoginIdstringOptional

createdDatestring · date-timeOptional

createdByUserLoginIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}/items/count

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/count HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportItem",
  "inventoryCountImportId": "text",
  "importItemSeqId": "text",
  "locationSeqId": "text",
  "statusId": "text",
  "productId": "text",
  "productIdentifier": "text",
  "quantity": 1,
  "countedByUserLoginId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "createdByUserLoginId": "text",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "count": 1
}

get InventoryCountImport

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

inventoryCountImportIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/{inventoryCountImportId}/stats

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/stats HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "statusDescription": "text",
  "facilityName": "text",
  "closedDate": "2025-12-17T13:25:23.183Z",
  "inventoryCountImportId": "text",
  "countImportName": "text",
  "countTypeEnumId": "text",
  "uploadedByUserLogin": "text",
  "facilityId": "text",
  "parentCountId": "text",
  "statusId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "dueDate": "2025-12-17T13:25:23.183Z",
  "totalItems": "text",
  "itemCounted": "text",
  "rejectedCount": "text",
  "totalVariance": "text",
  "statusHistory": "text"
}

findOrCreate RejectedItemCycleCount

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

productIdstringRequired

facilityIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/rejectedItems

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/rejectedItems HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "productId": "text",
  "facilityId": "text"
}

application/jsonmultipart/form-data

{
  "inventoryCountImportItem": {}
}

create InventoryCountImports

post

Service to create Inventory Count Imports

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportsarrayRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/bulk

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/bulk HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "inventoryCountImports": []
}

application/jsonmultipart/form-data

No content

get InventoryCountImportItemDetails

get

Service to get Inventory Count Import Item details.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

inventoryCountImportIdstringOptional

importItemSeqIdstringOptional

statusIdstringOptional

computeQOHstringOptional

orderBystringOptional

pageIndexinteger · int32Optional

The current page index to get the inventory count import items.

pageSizeinteger · int32Optional

The maximum number of inventory count import items to display.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/items

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/items HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "itemList": []
}

count InventoryCountImportView

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: co.hotwax.warehouse.InventoryCountImportView

statusDescriptionstringOptional

facilityNamestringOptional

closedDatestring · date-timeOptional

inventoryCountImportIdstringOptional

countImportNamestringOptional

countTypeEnumIdstringOptional

uploadedByUserLoginstringOptional

facilityIdstringOptional

parentCountIdstringOptional

statusIdstringOptional

createdDatestring · date-timeOptional

dueDatestring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/count

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/count HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 397

{
  "_entity": "co.hotwax.warehouse.InventoryCountImportView",
  "statusDescription": "text",
  "facilityName": "text",
  "closedDate": "2025-12-17T13:25:23.183Z",
  "inventoryCountImportId": "text",
  "countImportName": "text",
  "countTypeEnumId": "text",
  "uploadedByUserLogin": "text",
  "facilityId": "text",
  "parentCountId": "text",
  "statusId": "text",
  "createdDate": "2025-12-17T13:25:23.183Z",
  "dueDate": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "count": 1
}

get InventoryCountImportDetails

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

inventoryCountImportIdsarrayRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/stats

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/stats HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "inventoryCountImportIds": []
}

application/jsonmultipart/form-data

{
  "importStats": []
}

upload InventoryCountImports

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

uploadedFilestringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/upload

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/upload HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "uploadedFile": "text"
}

application/jsonmultipart/form-data

No content

list SystemMessage

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

systemMessageIdstringOptional

systemMessageTypeIdstringOptional

systemMessageRemoteIdstringOptional

Reference to the SystemMessageRemote record for the remote system this message came from for incoming messages or should be sent to for outgoing messages.

statusIdstringOptional

isOutgoingstringOptional

initDatestring · date-timeOptional

For incoming the received date, for outgoing the produced date

processedDatestring · date-timeOptional

For incoming the consumed date, for outgoing the sent date

lastAttemptDatestring · date-timeOptional

failCountnumber · int64Optional

parentMessageIdstringOptional

If a received message is split this is the original message

ackMessageIdstringOptional

The message received or sent to acknowledge this message

remoteMessageIdstringOptional

For messages to/from another Moqui system, the systemMessageId on the remote system; may also be used for other system level message IDs (as opposed to messageId which is for the ID in the envelope of the message)

messageTextstringOptional

senderIdstringOptional

ID of the sender (for OAGIS may be broken down into logicalId, component, task, referenceId; for EDI X12 this is ISA06)

receiverIdstringOptional

ID of the receiver (for OAGIS may also be broken down; for EDI X12 this is ISA08)

messageIdstringOptional

ID of the message; this may be globally unique (like the OAGIS BODID, a GUID) or only unique relative to the senderId and the receiverId (like EDI X12 ISA13 in the context of ISA06, ISA08), and may only be unique within a certain time period (ID may be reused since in EDI X12 limited to 9 digits)

messageDatestring · date-timeOptional

Date/time from message (for EDI X12 this is GS04 (date) and GS05 (time))

docTypestringOptional

For OAGIS the BSR Noun; For X12 GS01 (functional ID code)

docSubTypestringOptional

For OAGIS the BSR Verb; For X12 ST01 (tx set ID code)

docControlstringOptional

Control number of the message when applicable (such as GS06 in EDI X12 messages)

docSubControlstringOptional

Sub-Control number of the message when applicable (such as ST02 in EDI X12 messages)

docVersionstringOptional

The document version (for OAGIS BSR Revision, for X12 GS08 (version/revision))

triggerVisitIdstringOptional

Active visit when SystemMessage triggered (mainly produced) to track the user who did so; independent of the message transport which could have separate remote system and other Visit-like data.

productStoreIdstringOptional

shopIdstringOptional

orderIdstringOptional

consumeSmrIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/systemMessages

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "systemMessages",
    "systemMessageId": "text",
    "systemMessageTypeId": "text",
    "systemMessageRemoteId": "text",
    "statusId": "SmsgProduced",
    "isOutgoing": "text",
    "initDate": "2025-12-17T13:25:23.183Z",
    "processedDate": "2025-12-17T13:25:23.183Z",
    "lastAttemptDate": "2025-12-17T13:25:23.183Z",
    "failCount": 1,
    "parentMessageId": "text",
    "ackMessageId": "text",
    "remoteMessageId": "text",
    "messageText": "text",
    "senderId": "text",
    "receiverId": "text",
    "messageId": "text",
    "messageDate": "2025-12-17T13:25:23.183Z",
    "docType": "text",
    "docSubType": "text",
    "docControl": "text",
    "docSubControl": "text",
    "docVersion": "text",
    "triggerVisitId": "text",
    "productStoreId": "text",
    "shopId": "text",
    "orderId": "text",
    "consumeSmrId": "text",
    "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
  }
]

store SystemMessage

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

systemMessageIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: systemMessages

systemMessageIdstringOptional

systemMessageTypeIdstringOptional

systemMessageRemoteIdstringOptional

statusIdstring · enumOptionalPossible values:

isOutgoingstringOptional

initDatestring · date-timeOptional

processedDatestring · date-timeOptional

lastAttemptDatestring · date-timeOptional

failCountnumber · int64Optional

parentMessageIdstringOptional

ackMessageIdstringOptional

remoteMessageIdstringOptional

messageTextstringOptional

senderIdstringOptional

receiverIdstringOptional

messageIdstringOptional

messageDatestring · date-timeOptional

docTypestringOptional

docSubTypestringOptional

docControlstringOptional

docSubControlstringOptional

docVersionstringOptional

triggerVisitIdstringOptional

productStoreIdstringOptional

shopIdstringOptional

orderIdstringOptional

consumeSmrIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/cycleCounts/systemMessages/{systemMessageId}

HTTPcURLJavaScriptPython

POST /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 739

{
  "_entity": "systemMessages",
  "systemMessageId": "text",
  "systemMessageTypeId": "text",
  "systemMessageRemoteId": "text",
  "statusId": "SmsgProduced",
  "isOutgoing": "text",
  "initDate": "2025-12-17T13:25:23.183Z",
  "processedDate": "2025-12-17T13:25:23.183Z",
  "lastAttemptDate": "2025-12-17T13:25:23.183Z",
  "failCount": 1,
  "parentMessageId": "text",
  "ackMessageId": "text",
  "remoteMessageId": "text",
  "messageText": "text",
  "senderId": "text",
  "receiverId": "text",
  "messageId": "text",
  "messageDate": "2025-12-17T13:25:23.183Z",
  "docType": "text",
  "docSubType": "text",
  "docControl": "text",
  "docSubControl": "text",
  "docVersion": "text",
  "triggerVisitId": "text",
  "productStoreId": "text",
  "shopId": "text",
  "orderId": "text",
  "consumeSmrId": "text",
  "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
}

application/jsonmultipart/form-data

{
  "_entity": "systemMessages.PK",
  "systemMessageId": "text"
}

get UploadedCsvFile

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

systemMessageIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/systemMessages/{systemMessageId}/downloadFile

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId}/downloadFile HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "csvData": "text"
}

list SystemMessageError

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

systemMessageIdstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

errorDatestring · date-timeOptional

attemptedStatusIdstringOptional

errorTextstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/cycleCounts/systemMessages/{systemMessageId}/errors

HTTPcURLJavaScriptPython

GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId}/errors HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "moqui.service.message.SystemMessageError",
    "systemMessageId": "text",
    "errorDate": "2025-12-17T13:25:23.183Z",
    "attemptedStatusId": "text",
    "errorText": "text",
    "lastUpdatedStamp": "2025-12-17T13:25:23.183Z"
  }
]