BigCommerce · Schema
ReturnItem
A view of a returned item.
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | The unique identifier of this returned item. |
| reference_id | object | |
| quantity | integer | The quantity of items for which a return was requested. |
| total | string | The total price of the line item. |
| preferred_outcome | object | |
| reason | object | |
| received_state | object | |
| review_state | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ReturnItem",
"title": "ReturnItem",
"type": "object",
"description": "A view of a returned item.",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of this returned item."
},
"reference_id": {
"$ref": "#/components/schemas/ItemReferenceId"
},
"quantity": {
"type": "integer",
"description": "The quantity of items for which a return was requested."
},
"total": {
"type": "string",
"format": "decimal",
"description": "The total price of the line item."
},
"preferred_outcome": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Unique identifier of the preferred outcome."
},
"label": {
"type": "string",
"description": "A displayable label for the preferred outcome."
}
}
},
"reason": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Unique identifier of the reason."
},
"label": {
"type": "string",
"description": "A displayable label for the reason."
}
}
},
"received_state": {
"type": "object",
"properties": {
"received_quantity": {
"type": "integer",
"description": "The quantity of items marked as received by the merchant."
},
"pending_quantity": {
"type": "integer",
"description": "The quantity of items pending receipt by the merchant."
}
}
},
"review_state": {
"type": "object",
"properties": {
"approved_quantity": {
"type": "integer",
"description": "The quantity of items approved for return by the merchant."
},
"pending_quantity": {
"type": "integer",
"description": "The quantity of items pending receipt by the merchant."
},
"rejected_quantity": {
"type": "integer",
"description": "The quantity of items rejected by the merchant."
}
}
}
},
"x-internal": false
}