Access
| Property | Value |
|---|---|
| OAuth scope | purchases:irreversible |
| Effect | irreversible |
readOnlyHint | No |
destructiveHint | Yes |
idempotentHint | Yes |
openWorldHint | No |
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
request_id | string (uuid) | Yes | The Request’s id from list_requests. |
reason | bought_elsewhere, changed_product, no_longer_needed, price_changed, expired, reserved_elsewhere, executed_elsewhere, other | Yes | Why the person wants it closed. |
expected_version | integer | No | Optional. The Request version you last read. |
request_key | string | No | Optional. The same key repeats a change safely; one is derived when left out. |
Input JSON Schema
Input JSON Schema
{
"type": "object",
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"description": "The Request’s id from list_requests."
},
"reason": {
"type": "string",
"enum": [
"bought_elsewhere",
"changed_product",
"no_longer_needed",
"price_changed",
"expired",
"reserved_elsewhere",
"executed_elsewhere",
"other"
],
"description": "Why the person wants it closed."
},
"expected_version": {
"description": "Optional. The Request version you last read.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"request_key": {
"description": "Optional. The same key repeats a change safely; one is derived when left out.",
"type": "string",
"minLength": 8,
"maxLength": 64
}
},
"required": [
"request_id",
"reason"
],
"additionalProperties": false
}
Output JSON Schema
Output JSON Schema
{
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"request_id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"open",
"closed"
]
},
"status_label": {
"type": [
"string",
"null"
]
},
"words": {
"type": "string"
},
"country": {
"type": "string"
},
"currency": {
"type": "string"
},
"destination": {},
"need_by": {},
"time_horizon": {
"type": [
"string",
"null"
]
},
"delivery": {
"type": "array"
},
"all_items_required": {
"type": [
"boolean",
"null"
]
},
"items": {
"type": "array"
},
"price_limits": {
"type": "array"
},
"expires_at": {
"type": "string"
},
"next_step": {
"type": [
"string",
"null"
]
}
},
"required": [
"request_id",
"version",
"status",
"status_label",
"words",
"country",
"currency",
"destination",
"need_by",
"time_horizon",
"delivery",
"all_items_required",
"items",
"price_limits",
"expires_at",
"next_step"
],
"additionalProperties": {}
}
},
"required": [
"result"
],
"additionalProperties": false
}