Skip to content
Bottle

Record a cylinder you already have

POST
/assets
curl --request POST \
  --url https://example.com/assets \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "holder": { "kind": "place", "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "condition": "full", "state": "active", "references": { "additionalProperty": "example" }, "note": "example" }'

Names a cylinder that is already in a yard, on a vehicle, with a customer or a supplier, or lost. No stock moves: it is already counted where it is. The product must be set to track each cylinder.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
productId
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
holder
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id

UUID v7

string | null format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
condition
string | null
Allowed values: full empty
state

Active: in use. review: something about it needs checking. faulty: out of use until repaired. lost: not where it should be. retired: no longer used.

string
Allowed values: active review faulty lost retired
references
required
object
key
additional properties
string
<= 100 characters
note
string | null
<= 500 characters

Responses

Section titled “Responses”

201

Section titled “201”

Recorded

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
productId
required

UUID v7

string format: uuid
productName
required
string
state
required

Active: in use. review: something about it needs checking. faulty: out of use until repaired. lost: not where it should be. retired: no longer used.

string
Allowed values: active review faulty lost retired
condition
required
string | null
Allowed values: full empty
holder
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
references
required
Array<object>
object
definitionId
required

UUID v7

string format: uuid
name
required
string
value
required
string
lastMovedAt
required
string format: date-time
createdAt
required
string format: date-time
journey
required
Array<object>
object
id
required

UUID v7

string format: uuid
kind
required
string
Allowed values: registered moved reference_changed state_changed undone
from
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
to
required
object
kind
required
string
Allowed values: place vehicle customer supplier nowhere transit
id
required

UUID v7

string | null format: uuid
name
required
string | null
condition
required
string | null
Allowed values: full empty
state
required

Active: in use. review: something about it needs checking. faulty: out of use until repaired. lost: not where it should be. retired: no longer used.

string | null
Allowed values: active review faulty lost retired
references
required
Array<object>
object
definitionId
required

UUID v7

string format: uuid
name
required
string
value
required
string
orderId
required

UUID v7

string | null format: uuid
byName
required
string | null
note
required
string | null
at
required
string format: date-time
referenceHistory
required
Array<object>
object
definitionId
required

UUID v7

string format: uuid
name
required
string
value
required
string
from
required
string format: date-time
to
required
string | null format: date-time

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "state": "active",
  "condition": "full",
  "holder": {
    "kind": "place",
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  },
  "references": [
    {
      "definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "journey": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "kind": "registered",
      "from": {
        "kind": "place",
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      },
      "to": {
        "kind": "place",
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      },
      "condition": "full",
      "state": "active",
      "references": [
        {
          "definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ],
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "referenceHistory": [
    {
      "definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Missing scope or role, or the plan does not open Assets

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found, or Assets is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Assets is switched off, or another cylinder already has that detail

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}