Response Codes and Messages

Response codes are 6 digits long. The first digit indicates whether a request failed:

0 - the request was processed without errors
1 - the request failed.

The next two digits indicate the error category and subcategory and the last three digits are the specific error code for the category and subcategory indicated by the two digits before.

See the example below.

note

Note that in case of an error the returned HTTP response code matches the error that caused the request to fail (i.e., the only error that is returned if the debug property is set to false).

xxxxxx
││ └─ specific error code, 3 digits
│└─ error category and subcategory, 2 digits
│   ├─ 0 - not an error
│   │  ├─ 00 - no special messages
│   │  └─ 01 - info message
│   ├─ 1 - authentication errors
│   │  ├─ 11 - authentication failed
│   │  └─ 19 - other authentication related errors
│   ├─ 2 - data related errors
│   │  ├─ 21 - did not receive expected data
│   │  ├─ 22 - the received data has wrong format
│   │  ├─ 23 - the received data has invalid value
│   │  ├─ 24 - conflict with existing data
│   │  └─ 29 - other data related errors
│   ├─ 3 - permissions related errors
│   │  ├─ 31 - not allowed to pass this method
│   │  ├─ 32 - not allowed to pass this object or parameter
│   │  ├─ 33 - the passed value is out of the allowed range
│   │  └─ 39 - other permission related errors
│   └─ 9 - other errors
└─ whether a request failed, 1 digit
   ├─ 0 - request is successful
   └─ 1 - request failed

Initiate Cart

API Code	HTTP Code	API Message	Description
`000000`	`201`	`Success`	No errors or info messages.
`001001`	`201`	`Tag(s) [...] defined but not used`	The cart contains tag or tags that were defined in the request but were not applied to any items. This is not an error.
`001002`	`201`	`Undefined tags in item(s): [...]`	Some cart items are marked with tags that are not defined in the request. This is not an error.
`101001`	N/A	`Tag(s) [...] defined but not used`	The created cart contains a tag or tags that were defined in the request but were not applied to any items. This is not an error by itself but it is an additional message to a failed request (see the Testing and Debugging section for more information).
`101002`	N/A	`Undefined tags in item(s): [...]`	Some items are marked with tags that are not defined in the request. This is not an error. However, this message may accompany a failed request. See the Testing and Debugging section for more information.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121102`	`400`	`customerId required as there are items with enabled timer: [...]`	A timer, even if it's disabled, must be linked to a `customerId` value.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123000`	`400`	`Unknown currency`	The request contains a non-existing or unsupported currency code.
`123002`	`400`	`{0} has invalid value for item(s) [...]`	The provided value for the property specified in the request is invalid. The message contains a list of items that have the specified value.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`124101`	`409`	`cartId already exists`	For your account, there is already a cart initiated with the `cartId` value provided in the request.
`124102`	`409`	`customerId {0} is linked to itemId {1} in cartId {2} with an active timer`	The received request contains `itemId` with a timer already running for `customerId`. A customer cannot have more than one `itemId` with a running timer.
`124103`	`409`	`{itemId} does not exist`	The `itemId` value provided in the request is not added to your merchant account.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`132001`	`400`	`Insufficient permissions to set or modify amount settings`	Your account do not have enough permissions to change any of the following settings: `amount`; `amountMode`; `quantity`; `amountModifier`.
`132002`	`400`	`Insufficient permissions to set or modify timer settings`	Your account do not have enough permissions to change any of the following settings: `triggerEvent`; `manualAction`; `timerValue`.
`132003`	`400`	`Insufficient permissions to set or modify {0}`	You don't have enough privileges to set or modified the properties specified in the response message.
`133000`	`400`	`{0} value {1} is out of permitted range, item(s): [...]`	The value of the property specified in the request is in correct format but you do not have enough permissions to set this value. The message contains the list of items that have this error.
`133004`	`400`	`Insufficient permissions to set or modify amount settings, items: [...]`	Your account do not have enough permissions to change amount settings for items specified in the response message.
`133005`	`400`	`Insufficient permissions to set or modify timer settings, items: [...]`	Your account do not have enough permissions to change timer settings for items specified in the response message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Retrieve Status

API Code	HTTP Code	API Message	Description
`000000`	`200`	`Success`	No errors or info messages.
`001004`	`200`	`Requested cart does not contain tag(s) [...]`	The requested cart does not contain a tag or tags specified in the request. This is not an error for the status retrieval request if the request returns at least one `itemId`.
`001005`	`200`	`Requested cart does not contain itemId(s) [...]`	The requested cart does not contain an item or items specified in the request. This is not an error for status retrieval request if the request returns at least one `itemId`.
`001006`	`200`	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with explicitly enabled timer. This is not an error for the status retrieval request if the request returns at least one `itemId` based on other criteria.
`001007`	`200`	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with explicitly disabled timer. This is not an error for the status retrieval request if the request returns at least one `itemId`.
`101004`	N/A	`Requested cart does not contain tag(s) [...]`	The requested cart does not contain a tag or tags specified in the request. For status retrieval, this is not an error. However, this message may accompany a failed request. See the Testing and Debugging section for more information.
`101005`	N/A	`Requested cart does not contain itemId(s) [...]`	The requested cart does not contain an item or items specified in the request. For status retrieval, this is not an error. However, this message may accompany a failed request. See the Testing and Debugging section for more information.
`101006`	N/A	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with explicitly enabled timer.
`101007`	N/A	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with explicitly disabled timer. For status retrieval, this is not an error. However, this message may accompany a failed request. See the Testing and Debugging section for more information.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121103`	`400`	`No itemIds matching the request`	The request cannot be applied as it does not affect any itemIds in the requested cart. There must be at least one `itemId` that matches the request criteria.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123001`	`400`	`cartId does not exist`	The `cartId` value provided with the request was not previously initiated form your account.
`123002`	`400`	`{0} has invalid value for item(s) [...]`	The provided value for the property specified in the request is invalid. The message contains a list of items that have the specified value.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Cancel Cart or Items

API Code	HTTP Code	API Message	Description
`000000`	`200`	`Success`	No errors or info messages.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121103`	`400`	`No itemIds matching the request`	The request cannot be applied as it does not affect any itemIds in the requested cart. There must be at least one `itemId` that matches the request criteria.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123001`	`400`	`cartId does not exist`	The `cartId` value provided with the request was not previously initiated form your account.
`123002`	`400`	`{0} has invalid value for item(s) [...]`	The provided value for the property specified in the request is invalid. The message contains a list of items that have the specified value.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`124004`	`400`	`Requested cart does not contain tag(s) [...]`	No items in the requested cart are marked with the tag or tags specified in the request.
`124005`	`400`	`Requested cart does not contain itemId(s) [...]`	The requested cart do not contain item or items specified in the request.
`124006`	`400`	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with an explicitly enabled timer.
`124007`	`400`	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with an explicitly disabled timer.
`124103`	`409`	`{itemId} does not exist`	The `itemId` value provided in the request is not added to your merchant account.
`124114`	`400`	`No items in the authorized status`	The `cancel` request does not contain items in the `authorized` status. Only `authorized` items can be canceled.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Capture Cart or Items

API Code	HTTP Code	API Message	Description
`000000`	`200`	`Success`	No errors or info messages.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121103`	`400`	`No itemIds matching the request`	The request cannot be applied as it does not affect any itemIds in the requested cart. There must be at least one `itemId` that matches the request criteria.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123001`	`400`	`cartId does not exist`	The `cartId` value provided with the request was not previously initiated form your account.
`123002`	`400`	`{0} has invalid value for item(s) [...]`	The provided value for the property specified in the request is invalid. The message contains a list of items that have the specified value.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`124004`	`400`	`Requested cart does not contain tag(s) [...]`	No items in the requested cart are marked with the tag or tags specified in the request.
`124005`	`400`	`Requested cart does not contain itemId(s) [...]`	The requested cart do not contain item or items specified in the request.
`124006`	`400`	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with an explicitly enabled timer.
`124007`	`400`	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with an explicitly disabled timer.
`124103`	`409`	`{itemId} does not exist`	The `itemId` value provided in the request is not added to your merchant account.
`124114`	`400`	`No items in the authorized status`	The `cancel` request does not contain items in the `authorized` status. Only `authorized` items can be canceled.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Modify Cart or Items

API Code	HTTP Code	API Message	Description
`000000`	`200`	`Success`	No errors or info messages.
`001001`	`200`	`Tag(s) [...] defined but not used`	The cart contains tag or tags that were defined in the request but were not applied to any items. This is not an error.
`001002`	`200`	`Undefined tags in item(s): [...]`	Some cart items are marked with tags that are not defined in the request. This is not an error.
`001008`	`200`	`Timer already started, item(s): [...]`	The request contains an instruction to start a timer for an item or items whose timer is already in the `started` state. The timer status will remain unchanged. This is not an error.
`001009`	`200`	`Timer already stopped or expired, item(s): [...]`	The request contains an instruction to stop a timer for an item or items whose timer is already in the `stopped` or `expired` state. The timer status will remain unchanged. This is not an error. note `stopped` or `expired` timers cannot be restarted.
`001010`	`200`	`Timer already paused, items [...]`	The request contains an instruction to pause a timer for an item or items whose timer is already in the `paused` state. This is not an error. The timer status will remain unchanged. Paused timers can be resumed. See the Item Timers for more details.
`101001`	N/A	`Tag(s) [...] defined but not used`	The created cart contains a tag or tags that were defined in the request but were not applied to any items. This is not an error by itself but it is an additional message to a failed request (see the Testing and Debugging section for more information).
`101002`	N/A	`Undefined tags in item(s): [...]`	Some items are marked with tags that are not defined in the request. This is not an error. However, this message may accompany a failed request. See the Testing and Debugging section for more information.
`101008`	N/A	`Timer already started, item(s): [...]`	The request contains an instruction to start a timer for an item or items whose timer is already in the `started` state. The timer status will remain unchanged. This is not an error. However, this message may accompany a failed request. note `started` timers can expire, also, they can be `paused` or `stopped` for good. See the Item Timers section for more details.
`101009`	N/A	`Timer already stopped, item(s): [...]`	The request contains an instruction to stop a timer for an item or items whose timer is already in the `stopped` or `expired` state. The timer status will remain unchanged. This is not an error. However, this message may accompany a failed request. note `stopped` or `expired` timers cannot be restarted. See the Items Timers section for more information.
`101010`	N/A	`Timer already paused, item(s): [...]`	The request contains an instruction to pause a timer for an item or items whose timer is already in the `paused` state. The timer status will remain unchanged. This is not an error. However, this message may accompany a failed request. note `paused` timers can be resumed. See the Item Timers section for more details.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121102`	`400`	`customerId required as there are items with enabled timer: [...]`	A timer, even if it's disabled, must be linked to a `customerId` value.
`121103`	`400`	`No itemIds matching the request`	The request cannot be applied as it does not affect any itemIds in the requested cart. There must be at least one `itemId` that matches the request criteria.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123001`	`400`	`cartId does not exist`	The `cartId` value provided with the request was not previously initiated form your account.
`123002`	`400`	`{0} has invalid value for item(s) [...]`	The provided value for the property specified in the request is invalid. The message contains a list of items that have the specified value.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`124004`	`400`	`Requested cart does not contain tag(s) [...]`	No items in the requested cart are marked with the tag or tags specified in the request.
`124005`	`400`	`Requested cart does not contain itemId(s) [...]`	The requested cart do not contain item or items specified in the request.
`124006`	`400`	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with an explicitly enabled timer.
`124007`	`400`	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with an explicitly disabled timer.
`124102`	`409`	`customerId {0} is linked to itemId {1} in cartId {2} with an active timer`	The received request contains `itemId` with a timer already running for `customerId`. A customer cannot have more than one `itemId` with a running timer.
`124103`	`409`	`{itemId} does not exist`	The `itemId` value provided in the request is not added to your merchant account.
`124104`	`400`	`Cannot pause a pending timer, item(s): [...]`	The timer your are trying to pause is in the `pending` state. It has never been started. Only timers in the `started` state can be paused. note `pending` timers can be started by an event (a specified cart state) or manually. See the Item Timers section for more details.
`124105`	`400`	`Cannot pause an expired timer, item(s): [...]`	The timer your are trying to pause is in the `expired`. Only timers in the `started` state can be paused. note An `expired` timer cannot be started again for the same cart. See the Item Timers section for more details.
`124106`	`400`	`Cannot pause a stopped timer, item(s): [...]`	The timer your are trying to pause is in `stopped` state. It has never been started. Only timers in the `started` state can be paused. note `pending` timers can be started manually. See the Item Timers section for more details.
`124107`	`400`	`Cannot start a stopped timer, item(s): [...]`	The timer your are trying to start is in the `stopped` state. Only `pending` and `paused` state can be started. note The `stopped` state of a timer is the end of its lifesycle for a cart. See the Item Timers section for more details.
`124108`	`400`	`Cannot start an expired timer, item(s): [...]`	The timer your are trying to start is in the `expired` state. Only `pending` and `paused` state can be started. note The `expired` state of a timer is the end of its lifecycle for a cart. See the Item Timers section for more details.
`124109`	`400`	`Cannot stop a pending timer, item(s): [...]`	The timer your are trying to stop is in the `pending` state. It has never been started. Only `pending` and `paused` timers can be started. See the Item Timers section for more details.
`124110`	`400`	`Cannot stop an expired timer, item(s): [...]`	The timer your are trying to stop is in `expired` state. Only `started`, `paused`, or `pending` timers can be `stopped`. note The `expired` state of a timer is the end of its lifecycle for a cart. See the Item Timers section for more details.
`124111`	`400`	`Modified cart amount exceeds previous state`	Total modified cart amount must not exceed the amount the cart was initiated with. See the Modifying Items scetion for more information.
`124112`	`400`	`Modified item amount exceeds previous state for item(s): [...]`	The total item amount for of each item specified in the message must not exceed the initiated amount for these items.
`124113`	`400`	`Modified quantity exceeds previous state for item(s): [...]`	The modified `quantity` of each item specified in the message must not exceed the initiated quantity.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`132001`	`400`	`Insufficient permissions to set or modify amount settings`	Your account do not have enough permissions to change any of the following settings: `amount`; `amountMode`; `quantity`; `amountModifier`.
`132002`	`400`	`Insufficient permissions to set or modify timer settings`	Your account do not have enough permissions to change any of the following settings: `triggerEvent`; `manualAction`; `timerValue`.
`132003`	`400`	`Insufficient permissions to set or modify {0}`	You don't have enough privileges to set or modified the properties specified in the response message.
`133000`	`400`	`{0} value {1} is out of permitted range, item(s): [...]`	The value of the property specified in the request is in correct format but you do not have enough permissions to set this value. The message contains the list of items that have this error.
`133004`	`400`	`Insufficient permissions to set or modify amount settings, items: [...]`	Your account do not have enough permissions to change amount settings for items specified in the response message.
`133005`	`400`	`Insufficient permissions to set or modify timer settings, items: [...]`	Your account do not have enough permissions to change timer settings for items specified in the response message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Refund Cart or Items

API Code	HTTP Code	API Message	Description
`000000`	`200`	`Success`	No errors or info messages.
`111000`	`401`	`Authentication error`	OmniCart failed to authenticate the provided credentials. Please, verify the provided credentials are correct.
`121101`	`400`	`cartId cannot be empty`	`cartId` is required for this request.
`121103`	`400`	`No itemIds matching the request`	The request cannot be applied as it does not affect any itemIds in the requested cart. There must be at least one `itemId` that matches the request criteria.
`122001`	`400`	`{0} has invalid format`	The value specified in the error message did not pass the format check.
`122002`	`400`	`{0} has invalid format for item(s) [...]`	The value specified in the error message did not pass the format check. The message contains a list of items that have the specified value.
`123001`	`400`	`cartId does not exist`	The `cartId` value provided with the request was not previously initiated form your account.
`123003`	`400`	`{0} has invalid value`	The provided value for the property specified in the request is invalid.
`124004`	`400`	`Requested cart does not contain tag(s) [...]`	No items in the requested cart are marked with the tag or tags specified in the request.
`124005`	`400`	`Requested cart does not contain itemId(s) [...]`	The requested cart do not contain item or items specified in the request.
`124006`	`400`	`Requested cart does not contain items with enabled timer`	The requested cart does not contain items with an explicitly enabled timer.
`124007`	`400`	`Requested cart does not contain items with disabled timer`	The requested cart does not contain items with an explicitly disabled timer.
`124103`	`409`	`{itemId} does not exist`	The `itemId` value provided in the request is not added to your merchant account.
`124115`	`400`	`No items in the completed status`	The `refund` request does not contain items in the `completed` status. Only `completed` items can be refunded.
`131000`	`405`	`Not allowed to pass this method`	Your account fo not have enough permissions to pass this method.
`132000`	`400`	`Insufficient permissions to pass {0}`	Your account do not have enough permissions to pass the property specified in the message.
`199000`	`500`	`General system error`	Unspecified error on the OmniCart side.
`199001`	`404`	`Endpoint not found`	A 404 error.
N/A	`503`	N/A	OmniCart service is temporarily unavailable.

Initiate Cart​

Retrieve Status​

Cancel Cart or Items​

Capture Cart or Items​

Modify Cart or Items​

Refund Cart or Items​