{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MerchantOrderDto",
"title": "MerchantOrderDto",
"description": "Order",
"properties": {
"billing_address": {
"$ref": "#/components/schemas/address"
},
"captured_amount": {
"description": "The total amount of all captures. In minor units.",
"example": 0,
"format": "int64",
"type": "integer"
},
"captures": {
"description": "List of captures for this order.",
"items": {
"$ref": "#/components/schemas/Capture"
},
"type": "array"
},
"created_at": {
"description": "The time for the purchase. Formatted according to ISO 8601.",
"example": "2015-11-29T10:25:40Z",
"format": "date-time",
"type": "string"
},
"customer": {
"$ref": "#/components/schemas/customer"
},
"expires_at": {
"description": "Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.",
"example": "2015-12-04T10:26:06Z",
"format": "date-time",
"type": "string"
},
"fraud_status": {
"description": "Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.",
"example": "ACCEPTED",
"type": "string"
},
"initial_payment_method": {
"$ref": "#/components/schemas/InitialPaymentMethodDto"
},
"klarna_reference": {
"description": "A Klarna generated reference that is shorter than the Klarna Order Id and is used as a customer friendly reference. It is most often used as a reference when Klarna is communicating with the customer with regard to payment statuses.",
"example": "K4MADNY",
"type": "string"
},
"locale": {
"description": "The customers locale. Specified according to RFC 1766.",
"example": "en-us",
"type": "string"
},
"merchant_data": {
"description": "Text field for storing data about the order. Set at order creation.",
"example": "Order metadata",
"type": "string"
},
"merchant_reference1": {
"description": "The order number that the merchant should assign to the order. This is how a customer would reference the purchase they made. If supplied, it is labeled as the Order Number within post purchase communications as well as the Klarna App.",
"example": "10001",
"type": "string"
},
"merchant_reference2": {
"description": "Can be used to store your internal reference to the order. This is generally an internal reference number that merchants use as alternate identifier that matches their internal ERP or Order Management system.",
"example": "501",
"type": "string"
},
"order_amount": {
"description": "The order amount in minor units. That is the smallest currency unit available such as cent or penny.",
"format": "int64",
"type": "integer"
},
"order_id": {
"description": "The unique order ID. Cannot be longer than 255 characters.",
"example": "f3392f8b-6116-4073-ab96-e330819e2c07",
"type": "string"
},
"order_lines": {
"description": "An array of order_line objects. Each line represents one item in the cart.",
"items": {
"$ref": "#/components/schemas/order_line"
},
"type": "array"
},
"original_order_amount": {
"description": "The original order amount. In minor units.",
"format": "int64",
"type": "integer"
},
"purchase_country": {
"description": "The purchase country. Formatted according to ISO 3166-1 alpha-2.",
"example": "us",
"type": "string"
},
"purchase_currency": {
"description": "The currency for this order. Specified in ISO 4217 format.",
"example": "usd",
"type": "string"
},
"refunded_amount": {
"description": "The total amount of refunded for this order. In minor units.",
"example": 0,
"format": "int64",
"type": "integer"
},
"refunds": {
"description": "List of refunds for this order.",
"items": {
"$ref": "#/components/schemas/Refund"
},
"type": "array"
},
"remaining_authorized_amount": {
"description": "The remaining authorized amount for this order. To increase the `remaining_authorized_amount` the `order_amount` needs to be increased.",
"example": 0,
"format": "int64",
"type": "integer"
},
"selected_shipping_option": {
"$ref": "#/components/schemas/SelectedShippingOptionDto"
},
"shipping_address": {
"$ref": "#/components/schemas/address"
},
"shipping_info": {
"description": "Shipping information for this order.",
"items": {
"$ref": "#/components/schemas/shipping_info"
},
"type": "array"
},
"status": {
"description": "The order status.",
"enum": [
"AUTHORIZED",
"PART_CAPTURED",
"CAPTURED",
"CANCELLED",
"EXPIRED",
"CLOSED"
],
"example": "AUTHORIZED",
"type": "string"
}
},
"type": "object"
}