Link

Transaction Services

Transactions list

Return a list of all transactions for the current vendor.

HTTP Method / URL

GET /core/v2/rest/transaction

Security
  • Basic Authentication
  • API Key Identification
    • ROLE_APIKEY_ADMIN
    • ROLE_APIKEY_MAINTENANCE
    • ROLE_APIKEY_OPERATION
    • ROLE_APIKEY_ANALYTICS

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

GET https://go.netlicensing.io/core/v2/rest/transaction
Accept: application/xml

Response

<netlicensing xmlns="http://netlicensing.labs64.com/schema/context">
    <items>
        <item type="Transaction">
            <property name="number">T001</property>
            <property name="active">true</property>
            <property name="status">PENDING</property>
            <property name="source">SHOP</property>
        </item>
    </items>
</netlicensing>

Get transaction

Return a transaction by transactionNumber.

HTTP Method / URL

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

Security
  • Basic Authentication
  • API Key Identification
    • ROLE_APIKEY_ADMIN
    • ROLE_APIKEY_MAINTENANCE
    • ROLE_APIKEY_OPERATION
    • ROLE_APIKEY_ANALYTICS

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

GET https://go.netlicensing.io/core/v2/rest/transaction/T001
Accept: application/xml

Response

<netlicensing xmlns="http://netlicensing.labs64.com/schema/context">
    <items>
        <item type="Transaction">
            <property name="number">T001</property>
            <property name="active">true</property>
            <property name="status">PENDING</property>
            <property name="source">SHOP</property>
        </item>
    </items>
</netlicensing>

Create transaction

Creates a new transaction.

HTTP Method / URL

POST /core/v2/rest/transaction

Security

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

POST https://go.netlicensing.io/core/v2/rest/transaction
licenseeNumber=IP53OX9PF&number=TFMEIR1B9&active=true&status=PENDING&source=SHOP
Accept: application/xml
Content-Type: application/x-www-form-urlencoded

Response

<netlicensing xmlns="http://netlicensing.labs64.com/schema/context">
    <items>
        <item type="Transaction">
            <property name="number">TFMEIR1B9</property>
            <property name="active">true</property>
            <property name="status">PENDING</property>
            <property name="source">SHOP</property>
        </item>
    </items>
</netlicensing>

Update transaction

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

HTTP Method / URL

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

Security

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

POST https://go.netlicensing.io/core/v2/rest/transaction/TGG8UTJS8
number=TGG8UTJS8&active=false&status=CANCELLED
Accept: application/xml
Content-Type: application/x-www-form-urlencoded

Response

<netlicensing xmlns="http://netlicensing.labs64.com/schema/context">
    <items>
        <item type="Transaction">
            <property name="number">TGG8UTJS8</property>
            <property name="active">false</property>
            <property name="status">CANCELLED</property>
            <property name="source">SHOP</property>
        </item>
    </items>
</netlicensing>