Get order (admin)
GET
header
x-api-key<token>Organization-scoped API key with scope metadata.
id*stringSuccess
application/json- response
id*stringorderNumber*stringstatus*stringValue in
"placed""approved""fulfilled""cancelled"paymentStatus*stringValue in
"unpaid""authorized""paid""partially_refunded""refunded""voided""free"fulfillmentStatus*stringValue in
"unfulfilled""in_progress""fulfilled""not_required"items*array<>totals*shippingAddress*|nullbillingAddress*|nullshippingMethod*|nullpaymentMethod*|nullpaymentProvider*string|nullpaymentTransactionId*string|nullpaymentDetails*|nullcouponCode*string|nulltrackingNumber*string|nulltrackingUrl*string|nullnote*string|nullcustomerId*string|nullcontactEmail*string|nullrequiresShipping*booleanplacedAt*string|nullapprovedAt*string|nullcancelledAt*string|nullfulfilledAt*string|nullcreatedAt*stringupdatedAt*stringrefund*|provider: Prood can send the refund. manual: refund in the payment account first. Either way, recordOnly records a refund already made there. Null when nothing can be refunded.
curl -X GET 'https://api-prood.vercel.app/v1/admin/orders/string'Example Response
{ "id": "string", "orderNumber": "string", "status": "placed", "paymentStatus": "unpaid", "fulfillmentStatus": "unfulfilled", "items": [ { "id": "string", "productId": "string", "variantId": "string", "name": { "property1": "string", "property2": "string" }, "variantName": { "property1": "string", "property2": "string" }, "image": { "url": "string", "alt": "string", "width": 0, "height": 0 }, "quantity": 0, "price": { "amount": 0, "currency": "string", "formatted": "string" }, "totalPrice": { "amount": 0, "currency": "string", "formatted": "string" }, "fulfillmentStatus": "unfulfilled", "productType": "physical" } ], "totals": { "subtotal": { "amount": 0, "currency": "string", "formatted": "string" }, "shipping": { "amount": 0, "currency": "string", "formatted": "string" }, "tax": { "amount": 0, "currency": "string", "formatted": "string" }, "discount": { "amount": 0, "currency": "string", "formatted": "string" }, "total": { "amount": 0, "currency": "string", "formatted": "string" } }, "shippingAddress": { "firstName": "string", "lastName": "string", "phone": "string", "street": "string", "street2": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string" }, "billingAddress": { "firstName": "string", "lastName": "string", "phone": "string", "street": "string", "street2": "string", "city": "string", "state": "string", "country": "string", "postalCode": "string" }, "shippingMethod": { "id": "string", "name": { "property1": "string", "property2": "string" }, "provider": "string", "fulfillmentType": "shipping", "estimatedDays": { "min": 0, "max": 0 }, "price": { "amount": 0, "currency": "string", "formatted": "string" }, "cashOnDelivery": true }, "paymentMethod": { "id": "string", "type": "string", "name": { "property1": "string", "property2": "string" }, "provider": "string", "installments": { "count": 0, "amount": 0, "currency": "string" }, "icon": "string" }, "paymentProvider": "string", "paymentTransactionId": "string", "paymentDetails": { "method": "card", "entity": "string", "reference": "string", "expiresAt": "string" }, "couponCode": "string", "trackingNumber": "string", "trackingUrl": "string", "note": "string", "customerId": "string", "contactEmail": "string", "requiresShipping": true, "placedAt": "string", "approvedAt": "string", "cancelledAt": "string", "fulfilledAt": "string", "createdAt": "string", "updatedAt": "string", "refund": "provider"}