Skip to content
Bottle

Cancel a transfer

POST
/stock/transfers/{id}/cancel
curl --request POST \
  --url https://example.com/stock/transfers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/cancel \
  --cookie bottle.session_token=<bottle.session_token>

Before it arrives. Stock only held back is released; stock already in transit is returned to the yard it left, as a recorded movement.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

The transfer, with its lines and every stage it has been through

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
fromLocationId
required

UUID v7

string format: uuid
fromName
required
string
toLocationId
required

UUID v7

string format: uuid
toName
required
string
method
required
string
Allowed values: recorded carrier round
status
required
string
Allowed values: planned awaiting_collection in_transit received cancelled
roundId
required

UUID v7

string | null format: uuid
plannedFor
string | null format: date
proofs
Array<object>
object
leg
required
string
Allowed values: collection drop
kind
required
string
Allowed values: signature left_safe
signedBy
required
string | null
url
required
string
createdAt
required
string format: date-time
round
object
id
required

UUID v7

string format: uuid
roundDate
required
string format: date
vehicleName
required
string | null
driverName
required
string | null
carrierName
required
string | null
carrierReference
required
string | null
note
required
string | null
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
condition
required
string
Allowed values: full empty
quantity
required
integer
> 0
history
required
Array<object>
object
status
required
string
Allowed values: planned awaiting_collection in_transit received cancelled
at
required
string format: date-time
byName
required
string | null
createdByName
required
string | null
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "fromLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "toLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "method": "recorded",
  "status": "planned",
  "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "proofs": [
    {
      "leg": "collection",
      "kind": "signature"
    }
  ],
  "round": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  },
  "lines": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "condition": "full"
    }
  ],
  "history": [
    {
      "status": "planned"
    }
  ]
}

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”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

A product, yard or transfer that is not this business’s

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The transfer is not at a stage that allows this

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"
    }
  ]
}