TOtopi
ops
ops-assets

Update an asset's status

Changed on

Modify Asset Status

patch/ops/asset/{id}

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/asset/{id}
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-order:edit

Path parameters

idstring regexp required

topi asset ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Request body

state'created' | 'shipped' | 'return_completed' | 'purchased' | 'ops_canceled' required

Product payload

Example request

{
  "state": "shipped"
}

Response

OK response.

idstring regexp required

asset ID

offer_idstring regexp

reference to the originating offer

serial_numberstring

This is an id that identifies this asset as unique

status'created' | 'shipped' | 'return_completed' | 'purchased' | 'return_in_progress' | 'upgrade_in_progress' | 'purchase_in_progress' | 'upgrade_in_progress_in_term' | 'return_in_progress_in_term' | 'ops_canceled' | 'ending_soon' | 'overdue' required
subtitlestring

The asset title from txlog

titlestring required

The pretty name of the asset

txlog_statusstring

The status from txlog

Example response

{
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "offer_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "serial_number": "BA-3456786-334-9",
  "status": "shipped",
  "subtitle": "abc123",
  "title": "Pro Laptop 64GB",
  "txlog_status": "abc123"
}

Changes