Skip to main content

suppliers-changelog-tpw-operator

Release 8.0​

No change

Release 7.3​

RDTP-16918​

What's New​

GET /suppliers/{supplierUid}/serviceAccounts​
POST /suppliers/{supplierUid}/serviceAccounts​
GET /suppliers/{supplierUid}/serviceAccounts/{serviceAccountId}​
PUT /suppliers/{supplierUid}/serviceAccounts/{serviceAccountId}​
DELETE /suppliers/{supplierUid}/serviceAccounts/{serviceAccountId}​
POST /suppliers/{supplierUid}/serviceAccounts/{serviceAccountId}/secret​
GET /suppliers/{supplierUid}/serviceAccounts/groups​

RDTP-17900​

What's Changed​

All paths /suppliers/\{supplierUid\}/*​
Parameters:​

Changed: supplierUid in path

Unique identifier of the supplier, either

  • the sequential integer (UID) of the supplier
  • the identifier (ID) of the supplier prefixed by id:
  • the string mine to reference the supplier of the authenticated user requesting the API

RDTP-19834​

What's Changed​

GET /suppliers/{supplierUid}​

Retrieve Supplier

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • currency
  • validationState
PUT /suppliers/{supplierUid}​

Update Supplier

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • currency
  • validationState
GET /suppliers/{supplierUid}/applications​

Retrieve Applications

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      The following properties are now optional:

      • validationState
POST /suppliers/{supplierUid}/applications​

Create Application

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
  • Changed property state (string)

    The initial value is now ACTIVE (was TEST).

GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
GET /suppliers/{supplierUid}/applications/{applicationUid}/manifest​

Retrieve Manifest

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • m2mCredential
PUT /suppliers/{supplierUid}/applications/{applicationUid}/manifest​

Update Manifest

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • m2mCredential
GET /suppliers/{supplierUid}/devices​

Retrieve Devices

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      The following properties are now optional:

      • validationState
POST /suppliers/{supplierUid}/devices​

Create Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
GET /suppliers/{supplierUid}/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
PUT /suppliers/{supplierUid}/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
POST /suppliers/{supplierUid}/devices/{deviceUid}/versions​

Create Version

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status
GET /suppliers/{supplierUid}/devices/{deviceUid}/versions/{versionUid}​

Retrieve Version

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status
PUT /suppliers/{supplierUid}/devices/{deviceUid}/versions/{versionUid}​

Update Version

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status
POST /suppliers/{supplierUid}/gateways/{gatewayUid}/versions​

Create Version

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status
GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}​

Retrieve Version

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status
PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}​

Update Version

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • status

Create Logo

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • currency
  • validationState
PUT /suppliers/{supplierUid}/restricted​

Update Restricted

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • validationState
GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}​

Retrieve Order

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property orderContext (object)

    • Changed property products (object)

      • Changed property product (array)

        Changed items (object):

        The following properties are now optional:

        • currency

RDTP-21689​

What's Changed​

POST /suppliers/{supplierUid}/admins​

Create Admin

Request:​
  • Deprecated property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application. apiOnly user accounts are not subject to password expiration.

    This property must no longer be used: service accounts must be used to access the API.

Return Type:​

Changed response : 201 Created

Successful CREATE

  • Deprecated property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application. apiOnly user accounts are not subject to password expiration.

    This property must no longer be used: service accounts must be used to access the API.

Release 7.2​

No change

Release 7.1​

RDTP-15026​

What's Changed​

GET /suppliers/{supplierUid}/modules​

Retrieve Modules

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property authentication (string)

        Authentication protocol used by the module to authenticate the admin user.

        Enum values:

        • SMP
        • OIDC

Release 7.0​

RDTP-15723​

What's Deprecated​

GET /suppliers/{supplierUid}/applications/{applicationUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications/{applicationUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/applications/{applicationUid}/categories/{categoryUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications/{applicationUid}/x509Certif/generation​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications/{applicationUid}/x509Certif/invalidate​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications/{applicationUid}/x509Certif/regeneration​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/devices/{deviceUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/devices/{deviceUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/devices/{deviceUid}/categories/{categoryUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/devices/{deviceUid}/manifest/m2mProfiles​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/devices/{deviceUid}/manifest/m2mProfiles​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/devices/{deviceUid}/manifest/m2mProfiles/{m2mProfileUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/devices/{deviceUid}/restricted​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/gateways​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/gateways/{gatewayUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/gateways/{gatewayUid}/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/gateways/{gatewayUid}/categories/{categoryUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/images​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/gateways/{gatewayUid}/images​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/images/{imageUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/images/{imageUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/gateways/{gatewayUid}/images/{imageUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

This endpoint must no longer be used: the associated feature is no more available in the product.

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/gateways/{gatewayUid}/versions​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}/images​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}/images/{imageUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}/images/{imageUid}/settings​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}/versions/{versionUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/helpers/categories​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/helpers/currencies​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/helpers/m2mProfiles​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/helpers/shippingZones​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/shippingModes​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/shippingModes/{shippingModeUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/locals/{languageTag}​

This endpoint must no longer be used: the associated feature is no more available in the product.

This endpoint must no longer be used: the associated feature is no more available in the product.

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs/{tariffUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs/{tariffUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs/{tariffUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments​

This endpoint must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments​

This endpoint must no longer be used: the associated feature is no more available in the product.

DELETE /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments/{attachmentUid}​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property currency (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}​
Request:​
  • Deprecated property currency (string)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property currency (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/applications​
Parameters:​

Deprecated: categoryID in query

This parameter must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Deprecated property categories (object)

        This property must no longer be used: the associated feature is no more available in the product.

      • Deprecated property validationState (string)

        This property must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications​
Request:​

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/applications/{applicationUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/applications/{applicationUid}​
Request:​

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/applications/{applicationUid}/manifest​
Return Type:​

Changed response : 200 OK

  • Deprecated property m2mCredential (object)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/applications/{applicationUid}/manifest​
Request:​
  • Deprecated property m2mCredential (object)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property m2mCredential (object)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/applications/{applicationUid}/manifest/permissions​
Return Type:​

Changed response : 200 OK

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Deprecated property m2mProfile (object)

        This property must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/applications/{applicationUid}/options​
Request:​

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/applications/{applicationUid}/options/{optionUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/applications/{applicationUid}/options/{optionUid}​
Request:​

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property recurringInitialFreePeriod (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPeriodicity (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property recurringPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/devices​
Parameters:​

Deprecated: categoryID in query

This parameter must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Deprecated property categories (object)

        This property must no longer be used: the associated feature is no more available in the product.

      • Deprecated property status (string)

        This property must no longer be used: the associated feature is no more available in the product.

      • Deprecated property stock (integer)

        This property must no longer be used: the associated feature is no more available in the product.

      • Deprecated property upfrontPrice (number)

        This property must no longer be used: the associated feature is no more available in the product.

      • Deprecated property validationState (string)

        This property must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/devices​
Request:​

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property weight (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property width (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property height (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property depth (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (string)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property weight (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property width (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property height (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property depth (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property weight (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property width (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property height (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property depth (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/devices/{deviceUid}​
Request:​

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property weight (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property width (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property height (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property depth (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (string)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property upfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property weight (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property width (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property height (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property depth (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

POST /suppliers/{supplierUid}/devices/{deviceUid}/versions​
Request:​

  • Deprecated property deltaUpfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

  • Deprecated property deltaUpfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/devices/{deviceUid}/versions/{versionUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property deltaUpfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/devices/{deviceUid}/versions/{versionUid}​
Request:​

  • Deprecated property deltaUpfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property deltaUpfrontPrice (number)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property status (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property stock (integer)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /suppliers/{supplierUid}/restricted​
Request:​
  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property validationState (string)

    This property must no longer be used: the associated feature is no more available in the product.

GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}​
Return Type:​

Changed response : 200 OK

  • Changed property orderContext (object)

    • Changed property products (object)

      • Changed property product (array)

        Changed items (object):

        • Deprecated property currency (string)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property initiaFreePeriod (string)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property periodicity (string)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property pricePlanVersion (integer)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property recurringPrice (number)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property upfrontPrice (number)

          This property must no longer be used: the associated feature is no more available in the product.

        • Deprecated property upfrontTax (number)

          This property must no longer be used: the associated feature is no more available in the product.

    • Deprecated property shippingMode (object)

      This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property shipping (object)

    This property must no longer be used: the associated feature is no more available in the product.

No change

Release 6.1​

RDTP-6628 / RDTP-8975​

What's Changed​

GET /suppliers/{supplierUid}/subscribers/orders​

Retrieve Orders

Parameters:​

Added: contextID in query

Returns Order Batches for which the Order Context matches the provided ID

Added: contextState in query

Only returns Order Batches for which the Order Context matches any provided state

Added: contextUpdatedAfter in query

Returns Orders where the current Order Context timestamp >= contextUpdatedAfter

Added: productSKU in query

Returns Order Batches containing the Product matching the provided SKU

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property orderContext (object)

        • Property ID (string)

          Order Context ID

        • Property state (string)

          Current Order Context state

          Enum values:

          • INIT
          • TRYING
          • VALIDATED
          • PROCESSING
          • PROCESSING/WAIT_PAYMENT_CONF
          • COMPLETED
          • ABORTING
          • ABORTED

        • Property timestamp (string)

          Current Order Context timestamp

GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}​

Retrieve Order

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • businessKey

  • Added property businessKey (string)

    Order Batch business key

  • Changed property orderContext (object)

    • Added property ID (string)

      Order Context ID

    • Changed property products (object)

      • Changed property product (array)

        Changed items (object):

        • Added property SKU (string)

          Stock Keeping Unit

Release 6.0​

RDTP-2488​

What's Changed​

POST /suppliers/{supplierUid}/applications​

Create Application

Request:​
  • Added property permissionsSupported (boolean)
Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property permissionsSupported (boolean)
GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property permissionsSupported (boolean)
PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property permissionsSupported (boolean)

RDTP-6886​

What's New​

GET /suppliers/{supplierUid}/helpers/customFieldSets​

Retrieve Custom Field Sets

GET /suppliers/{supplierUid}/helpers/customFieldSets/{customFieldSetUid}​

Retrieve Custom Field Set

What's Deleted​

GET /suppliers/{supplierUid}/helpers/applications/customFieldSets​

Retrieve Application Custom Field Sets

GET /suppliers/{supplierUid}/helpers/devices/customFieldSets​

Retrieve Device Custom Field Sets

GET /suppliers/{supplierUid}/helpers/gateways/customFieldSets​

Retrieve Gateway Custom Field Sets

What's Changed​

GET /suppliers/{supplierUid}​

Retrieve Supplier

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

PUT /suppliers/{supplierUid}​

Update Supplier

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

POST /suppliers/{supplierUid}/applications​

Create Application

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

GET /suppliers/{supplierUid}/devices​

Retrieve Devices

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Changed property customFieldSet (object)

        New required properties:

        • href

        • Added property href (string)

          HREF to retrieve the Custom Field Set using helpers WS

POST /suppliers/{supplierUid}/devices​

Create Device

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

GET /suppliers/{supplierUid}/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

PUT /suppliers/{supplierUid}/devices/{deviceUid}​

Update Device

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

POST /suppliers/{supplierUid}/gateways​

Create Gateway

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

GET /suppliers/{supplierUid}/gateways/{gatewayUid}​

Retrieve Gateway

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}​

Update Gateway

Request:​

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property customFields (object)

    • Changed property customField (array)

      List of Custom Fields

      Changed items (object):

      • Deleted property enumerate (object)

      • Changed property enumValue (array -> object)

        enumerate value (only applicable if type is ENUMERATE)

        Items (object):

        • Added property ID (string)

          enumerate value ID

        • Added property name (string)

          enumerate value name

  • Changed property customFieldSet (object)

    New required properties:

    • href

    • Added property href (string)

      HREF to retrieve the Custom Field Set using helpers WS

RDTP-8035​

What's New​

GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments​

Retrieve Attachments

POST /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments​

Create Attachment

DELETE /suppliers/{supplierUid}/subscribers/orders/{orderUid}/attachments/{attachmentUid}​

Delete Attachment

What's Changed​

GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}​

Retrieve Order

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property orderContext (object)

    • Changed property shippingMode (object)

      Shipping Mode (only when the Order Context contains some Devices or Gateways)

      • Added property upfrontTax (number)

        Supplier shipping upfront tax

      • Deleted property supplierUpfrontTax (number)

        Supplier shipping upfront tax

RDTP-9328​

What's New​

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones​

Retrieve Shipping Zones

POST /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones​

Create Shipping Zone

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

Retrieve Shipping Zone

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

Update Shipping Zone

DELETE /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/shippingZones/{shippingZoneUid}​

Delete Shipping Zone

What's Changed​

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs​

Retrieve Tariffs

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Changed property zone (object)

        • Added property href (string)

          Shipping zone HREF. Only returned for Shipping Zones associated with the Shipping Mode.

        • Added property ID (string)

          Shipping zone ID

POST /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs​

Create Tariff

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property zone (object)

    • Added property href (string)

      Shipping zone HREF. Only returned for Shipping Zones associated with the Shipping Mode.

    • Added property ID (string)

      Shipping zone ID

GET /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs/{tariffUid}​

Retrieve Tariff

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property zone (object)

    • Added property href (string)

      Shipping zone HREF. Only returned for Shipping Zones associated with the Shipping Mode.

    • Added property ID (string)

      Shipping zone ID

PUT /suppliers/{supplierUid}/shippingModes/{shippingModeUid}/tariffs/{tariffUid}​

Update Tariff

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property zone (object)

    • Added property href (string)

      Shipping zone HREF. Only returned for Shipping Zones associated with the Shipping Mode.

    • Added property ID (string)

      Shipping zone ID

Release 5.2.2​

RDTP-6196​

What's New​

PUT /suppliers/{supplierUid}/devices/{deviceUid}/restricted​

Update Device Restricted Settings

What's Changed​

GET /suppliers/{supplierUid}​

Retrieve Supplier

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property validationState (string)

    Supplier validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
PUT /suppliers/{supplierUid}​

Update Supplier

Request:​

** /!\ TODO /!\ **

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property validationState (string)

    Supplier validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/applications​

Retrieve Applications

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      New required properties:

      • validationState

      • Added property validationState (string)

        Application validation state controlled by the contracting Operator

        Enum values:

        • VALIDATING
        • VALIDATED
        • SUSPENDED
POST /suppliers/{supplierUid}/applications​

Create Application

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Application validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Application validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Application validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/devices​

Retrieve Devices

Parameters:​

Added: validationState in query

Returns Devices matching the validation state (exact match).

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      New required properties:

      • validationState

      • Added property validationState (string)

        Device validation state controlled by the contracting Operator

        Enum values:

        • VALIDATING
        • VALIDATED
        • SUSPENDED
POST /suppliers/{supplierUid}/devices​

Create Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Device validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Device validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
PUT /suppliers/{supplierUid}/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Device validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/gateways​

Retrieve Gateways

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      New required properties:

      • validationState

      • Added property validationState (string)

        Gateway validation state controlled by the contracting Operator

        Enum values:

        • VALIDATING
        • VALIDATED
        • SUSPENDED
POST /suppliers/{supplierUid}/gateways​

Create Gateway

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Gateway validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
GET /suppliers/{supplierUid}/gateways/{gatewayUid}​

Retrieve Gateway

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Gateway validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
PUT /suppliers/{supplierUid}/gateways/{gatewayUid}​

Update Gateway

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState

  • Added property validationState (string)

    Gateway validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
PUT /suppliers/{supplierUid}/restricted​

Update Restricted

Request:​

  • Added property validationState (string)

    Supplier validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property validationState (string)

    Supplier validation state controlled by the contracting Operator

    Enum values:

    • VALIDATING
    • VALIDATED
    • SUSPENDED

RDTP-6198​

What's Changed​

GET /suppliers/{supplierUid}/applications​

Retrieve Applications

Parameters:​

Added: SKU in query

Returns Applications matching the SKU (exact match).

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property SKU (string)

        Stock Keeping Unit

POST /suppliers/{supplierUid}/applications​

Create Application

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/applications/{applicationUid}/options​

Retrieve Options

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property SKU (string)

        Stock Keeping Unit

POST /suppliers/{supplierUid}/applications/{applicationUid}/options​

Create Option

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/applications/{applicationUid}/options/{optionUid}​

Retrieve Option

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

PUT /suppliers/{supplierUid}/applications/{applicationUid}/options/{optionUid}​

Update Option

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/devices​

Retrieve Devices

Parameters:​

Added: SKU in query

Returns Devices matching the SKU (exact match).

Added: minUpfrontPrice in query

Only returns Devices for which the upfront price is equal or greater than the provided minimum value.

Added: maxUpfrontPrice in query

Only returns Devices for which the upfront price is equal or lower than the provided maximum value.

Added: status in query

Returns Devices matching the status:

  • IN_STOCK: status must match IN_STOCK
  • OUT_STOCK: status must match P7D, P15D, P1M, RESTOCKING or SOLD_OUT

Added: minStock in query

Only returns Devices for which the stock quantity is equal or greater than the provided minimum value.

Added: maxStock in query

Only returns Devices for which the stock quantity is equal or lower than the provided maximum value.

Added: customFieldSetID in query

Returns Devices matching the Custom Field Set ID (exact match).

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property upfrontPrice (number)

      • Added property customFieldSet (object)

        • Property ID (string)

          ID of the Custom Field Set associated with the Resource

        • Property name (string)

          Name of the Custom Field Set associated with the Resource

      • Added property stock (integer)

        Inventory elements:

        • Returns inventory information elements of the Device, when the Device does not have Version
        • When the Device has at least one Version, the inventory information elements are not returned.

      • Added property SKU (string)

        Stock Keeping Unit

      • Added property status (string)

        Inventory elements:

        • Returns inventory information elements of the Device, when the Device does not have Version
        • When the Device has at least one Version, the inventory information elements are not returned.

        Enum values:

        • IN_STOCK
        • P7D
        • P15D
        • P1M
        • RESTOCKING
        • SOLD_OUT
POST /suppliers/{supplierUid}/devices​

Create Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

PUT /suppliers/{supplierUid}/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/gateways​

Retrieve Gateways

Parameters:​

Added: SKU in query

Returns Gateways matching the SKU (exact match).

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property SKU (string)

        Stock Keeping Unit

POST /suppliers/{supplierUid}/gateways​

Create Gateway

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

GET /suppliers/{supplierUid}/gateways/{gatewayUid}​

Retrieve Gateway

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}​

Update Gateway

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property SKU (string)

    Stock Keeping Unit

Release 5.1​

General​

No change

Release 5.0.1​

General​

What's New​

GET /suppliers/{supplierUid}/helpers/applications/customFieldSets​

Retrieve Application Custom Field Sets

GET /suppliers/{supplierUid}/helpers/devices/customFieldSets​

Retrieve Device Custom Field Sets

GET /suppliers/{supplierUid}/helpers/gateways/customFieldSets​

Retrieve Gateway Custom Field Sets

GET /suppliers/{supplierUid}/helpers/vendors​

Retrieve Vendors

What's Changed​

GET /suppliers/{supplierUid}​

Retrieve Supplier

Parameters:​

Added: customFields in query

Return custom fields. When this query parameter is not specified in the request, custom fields are not returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFieldSet (object)

  • Added property exclusiveVendor (object)

  • Added property customFields (object)

PUT /suppliers/{supplierUid}​

Update Supplier

Request:​
  • Added property customFields (object)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFieldSet (object)

  • Added property exclusiveVendor (object)

  • Added property customFields (object)

POST /suppliers/{supplierUid}/applications​

Create Application

Request:​
  • Added property customFieldSet (object)
Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

GET /suppliers/{supplierUid}/applications/{applicationUid}​

Retrieve Application

Parameters:​

Added: customFields in query

Return custom fields. When this query parameter is not specified in the request, custom fields are not returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

PUT /suppliers/{supplierUid}/applications/{applicationUid}​

Update Application

Request:​
  • Added property customFields (object)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

POST /suppliers/{supplierUid}/devices​

Create Device

Request:​
  • Added property customFieldSet (object)
Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property customFieldSet (object)

  • Added property pricePlan (object)

  • Added property customFields (object)

GET /suppliers/{supplierUid}/devices/{deviceUid}​

Retrieve Device

Parameters:​

Added: customFields in query

Return custom fields. When this query parameter is not specified in the request, custom fields are not returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFieldSet (object)

  • Added property pricePlan (object)

  • Added property customFields (object)

PUT /suppliers/{supplierUid}/devices/{deviceUid}​

Update Device

Request:​

  • Added property pricePlan (object)

  • Added property customFields (object)

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFieldSet (object)

  • Added property pricePlan (object)

  • Added property customFields (object)

POST /suppliers/{supplierUid}/gateways​

Create Gateway

Request:​
  • Added property customFieldSet (object)
Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

GET /suppliers/{supplierUid}/gateways/{gatewayUid}​

Retrieve Gateway

Parameters:​

Added: customFields in query

Return custom fields. When this query parameter is not specified in the request, custom fields are not returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

PUT /suppliers/{supplierUid}/gateways/{gatewayUid}​

Update Gateway

Request:​
  • Added property customFields (object)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property customFields (object)

  • Added property customFieldSet (object)

GET /suppliers/{supplierUid}/helpers/categories​

Retrieve Categories

Parameters:​

Added: type in query

Returns Categories matching the type (exact match). When this query parameter is not specified in the request, only SELLING categories are returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (object)

      • Added property type (string)

        Category type

PUT /suppliers/{supplierUid}/restricted​

Update Restricted

Request:​
  • Added property exclusiveVendor (object)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property exclusiveVendor (object)
GET /suppliers/{supplierUid}/subscribers/orders/{orderUid}​

Retrieve Order

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property orderContext (object)

    • Changed property shippingMode (object)

      Shipping Mode (only when the Order Context contains some Devices or Gateways)

      • Added property supplierUpfrontTax (number)

        Supplier shipping upfront tax

    • Changed property products (object)

      • Changed property product (object)

        • Added property upfrontTax (number)

          Supplier selling upfront tax

        • Added property pricePlanVersion (integer)

          Supplier selling price plan version

Last updated on
Copyright © 2025 Actility
On this page