| Response Structure |
: |
// Success
{
"status_code": 200,
"status_message": "OK",
"message": "orderRetrievedSuccessfully",
"is_data": true,
"data": {
"type": "String",
"paymentLink": "String|Nullable",
"orderUuid": "String",
"invoiceNumber": "String|Nullable",
"status": "String",
"productList": [
{
"name": "String",
"productId": "String",
"quantity": "Integer",
"rate": "Float",
"discount": "Float",
"tax": "Float",
"amount": "Float"
}
],
"orderSummary": {
"subTotal": "Float",
"tax": "Float",
"discount": "Float",
"grandTotal": "Float"
},
"invoiceAsPaymentOption": "Boolean|Tiny Integer",
"orderDate": "String",
"paymentLinkDueDate": "String",
"sendOrderBy": {
"sms": "Boolean",
"email": "Boolean",
"invoice": "Boolean"
},
"creditCheck": "Boolean",
"customerDetails": {
"type": "String",
"uuid": "String",
"countryCode": "String",
"msisdn": "String",
"email": "String",
"name": "String",
"preferredLanguage": "String",
"personalNumber": "String|Nullable",
"organizationId": "String|Nullable",
"address": {
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"invoiceReferences": "String|Nullable",
"internalReferences": "String|Nullable",
"organizationDetails": {
"name": "String",
"billingAddress": {
"countryCode": "String",
"msisdn": "String",
"email": "String",
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"translationKey": "String",
"creditCheckHistory": "String|Nullable",
"businessInformation": {
"name": "string",
"type": "string",
"location": "String"
},
"organizationUuid": "String",
"redirectionUrls": "Array|Nullable",
"paymentHistory": {
"paidAt": "String|Nullable",
"amount": "Float|Nullable",
"refunded": "Float|Nullable",
"refunds": [
{
"at": "String|Nullable",
"amount": "Float|Nullable",
"isRefunded": "Boolean",
"isPartial": "Boolean"
}
]
}
}
}
// Errors
{
"status_code": 404,
"status_message": "Not Found",
"message": "Order Not Found",
"is_data": false,
"data": null
}
{
"status_code": 510,
"status_message": "Execution Exception Occurred",
"message": "Something Went Wrong",
"is_error": true,
"errors": "Array"
}
|
| Example Response |
: |
{
"status_code": 200,
"status_message": "OK",
"message": "orderRetrievedSuccessfully",
"is_data": true,
"data": {
"type": "REGULAR",
"paymentLink": null,
"orderUuid": "ODR986760186",
"invoiceNumber": null,
"status": "INVOICED",
"productList": [
{
"name": "Router",
"productId": "R_1",
"quantity": 1,
"rate": 4500,
"discount": 0,
"tax": 0,
"amount": 4500
}
],
"orderSummary": {
"subTotal": 4017.86,
"tax": 482.14,
"discount": 0,
"grandTotal": 4500
},
"invoiceAsPaymentOption": 1,
"orderDate": "02.08.2023",
"paymentLinkDueDate": "07:11, 04.08.2023",
"sendOrderBy": {
"sms": false,
"email": true,
"invoice": false
},
"creditCheck": false,
"customerDetails": {
"type": "Private",
"uuid": "CSRT197366289",
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]",
"name": "Kari Nordmann",
"preferredLanguage": "en",
"personalNumber": null,
"organizationId": null,
"address": {
"street": "Luramyrveien 65",
"zip": "4313",
"city": "Sandnes",
"country": "NO"
}
},
"invoiceReferences": null,
"internalReferences": null,
"organizationDetails": {
"name": "Partex",
"billingAddress": {
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]",
"street": "Luramyrveien 65",
"zip": "4313",
"city": "Sandnes",
"country": "NO"
}
},
"translationKey": "orderInvoiced",
"creditCheckHistory": null,
"businessInformation": {
"name": "Partex",
"type": "Business and Industrial Markets",
"location": "stenifs"
},
"organizationUuid": "ORG2111119716",
"redirectionUrls": null,
"paymentHistory": {
"paidAt": "1710741595",
"amount": 100.50,
"refunded": 70,
"refunds": [
{
"at": "1710741705",
"amount": 10,
"isRefunded": true,
"isPartial": true
},
{
"at": "1710741769",
"amount": 30,
"isRefunded": true,
"isPartial": true
},
{
"at": "1710741794",
"amount": 30,
"isRefunded": true,
"isPartial": true
}
]
}
}
}
|
