Skip to content
Bottle

Withdraw a cylinder report

POST
/storefront/sites/{host}/account/cylinders/reports/{reportId}/withdraw
curl --request POST \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/cylinders/reports/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/withdraw

Deliberately without a staff session: a shopper on the business’s own shop. While the business has not acted on it: the report is kept, marked withdrawn, and nothing about the holding has changed. 409 already_decided once it is acted on.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string

Example 

northgate.shop.getbottle.app
reportId
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Taken back

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
productId
required

UUID v7

string format: uuid
name
required
string
quantity
required
integer
> 0
problem
required

What the customer said happened: lost, stolen, damaged, or moved to another supplier.

string
Allowed values: lost stolen damaged moved_supplier
status
required

Pending: waiting for the business. written_off: the holding ended, with no charge. invoiced: the holding ended and the customer was invoiced. dismissed: closed with nothing changed. withdrawn: the customer took it back first.

string
Allowed values: pending written_off invoiced dismissed withdrawn
note
required
string | null
reportedAt
required
string format: date-time
decidedAt
required
string | null format: date-time
businessNote
required
string | null
invoicePence
required
integer | null

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "problem": "lost",
  "status": "pending"
}

400

Section titled “400”

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

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 from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

Already decided, or the shop is not selling now

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

429

Section titled “429”

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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