Skip to end of metadata
Go to start of metadata

Transactions list

Return a list of all transactions for the current vendor.

HTTP Method / URL

GET /core/v2/rest/transaction

Security

Basic Authentication

Request Header

Accept: application/json | application/xml

Request Parameters

- None -

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TransactionService.list

 Example
Request
Response

Get transaction

Return a transaction by transactionNumber.

HTTP Method / URL

GET /core/v2/rest/transaction/{transactionNumber}

Security

Basic Authentication

Request Header

Accept: application/json | application/xml

Request Parameters

transactionNumber (string) - Transaction number.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TransactionService.get

 Example
Request
Response

Create transaction

Creates a new transaction.

HTTP Method / URL

POST /core/v2/rest/transaction

Security

Basic Authentication

Request Header

Accept: application/json | application/xml
Content-Type: application/x-www-form-urlencoded

Request Parameters

licenseeNumber (string) - Licensee number.

number (string) - Unique number (across all products of a vendor) that identifies the transaction. Optional.

active (boolean) - Always true for transactions.

status (string) - Status of transaction. "CANCELLED", "CLOSED", "PENDING".

source (string) - "SHOP". AUTO transaction for internal use only.

dateCreated (date-time) - Date created. Optional.

dateClosed (date-time) - Date closed. Optional.

paymentMethod (string) - Payment method. Optional.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TransactionService.create

 Example
Request
Response

Update transaction

Sets the provided properties to a transaction. Return an updated transaction.

HTTP Method / URL

POST /core/v2/rest/transaction/{transactionNumber}

Security

Basic Authentication

Request Header

Accept: application/json | application/xml
Content-Type: application/x-www-form-urlencoded

Request Parameters

transactionNumber (string) - Transaction number

number (string) - Unique number (across all products of a vendor) that identifies the transaction. Optional.

active (boolean) - Always true for transactions. Optional.

status (string) - Status of transaction. "CANCELLED", "CLOSED", "PENDING". Optional.

source (string) - "SHOP". AUTO transaction for internal use only. Optional.

dateCreated (date-time) - Date created. Optional.

dateClosed (date-time) - Date closed. Optional.

paymentMethod (string) - Payment method. Optional.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: TransactionService.update

 Example
Request
Response