| Response Structure |
: |
// Success
{
"status_code": 200,
"status_message": "OK",
"message": "orderRetrievedSuccessfully"reservationRetrievedSuccessfully",
"is_data": true,
"data": {
"type"reservationUuid": "String",
"paymentLink": "String|Nullable",
"orderUuid": "String",
"invoiceNumber": "String|Nullable",
"status": "String",
"isPaid": "Boolean",
"productList": [
{
"id": "Integer",
"name": "String",
"productId": "String",
"quantity": "Integer"Float",
"rate": "Float",
"discount": "Float",
"tax": "Integer",
"amount": "Float",
"amount"reserved": "Float",
"captured": "Float"
}
],
"orderSummary": {
"subTotal"grandTotal": "Float",
"tax": "Float",
"discount": "Float",
"grandTotal": "Float"
},
"invoiceAsPaymentOption": "Boolean|Tiny Integer",
"orderDate"reservationDate": "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"referenceNumber": "String|Nullable"Nullable|String",
"internalReferences"customerReference": "String|Nullable"Nullable|String",
"customerNotes": "Nullable|String",
"termsAndCondition": "Nullable|String",
"paymentDetails": {
"reservedAt": "Timestamp",
"reservedAmount": "Float",
"capturedAmount": "Float",
"chargedAmount": "Float",
"amountRefunded": {
"fromCaptured": "Float",
"fromCharge": "Float"
}
},
"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"
}
}
// 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"reservationRetrievedSuccessfully",
"is_data": true,
"data": {
"type"reservationUuid": "REGULAR"RES3633019929",
"paymentLink": null,
"orderUuid": "ODR986760186",
"invoiceNumber": null,
"status": "INVOICED"RESERVED",
"isPaid": true,
"productList": [
{
"id": 33,
"name": "Router",
"productId": "R_1",
"quantity": 1,
"rate": 4500,
"discount": 0,
"tax": 0,12,
"amount": 45004500,
"reserved": 0,
"captured": 0
}
],
"orderSummary": {
"subTotal": 4017.86,
"tax": 482.14,
"discount": 0,
"grandTotal": 4500
},4500,
"invoiceAsPaymentOption": 1,
"orderDate"reservationDate": "02.07.08.2023",
"paymentLinkDueDate": "07:11,09:05, 04.09.08.2023",
"sendOrderBy": {
"sms": false,
"email": true,
"invoice": falsetrue
},
"creditCheck": false,
"customerDetails": {
"type": "Private",
"uuid": "CSRT197366289",
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]"[email protected]",
"name": "Zahidul",
"preferredLanguage": "en",
"personalNumber": null,
"organizationId": null,
"address": {
"street": "KlosterengetHatirpool, 144"Dhanmondi 27",
"zip": "7030"1205",
"city": "Trondheim"Dhaka",
"country": "Norway"
}
},
"invoiceReferences"referenceNumber": null,
"internalReferences"customerReference": null,
"customerNotes": null,
"termsAndCondition": null,
"paymentDetails": {
"reservedAt": 1691392018,
"reservedAmount": 4500,
"capturedAmount": 0,
"chargedAmount": 11500,
"amountRefunded": {
"fromCaptured": 0,
"fromCharge": 50
}
},
"organizationDetails": {
"name": "Partex",
"billingAddress": {
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]",
"street": "sdsd",
"zip": "3933",
"city": "stenifs",
"country": "norway"
}
},
"translationKey": "orderInvoiced",
"creditCheckHistory": null,
"businessInformation": {
"name": "Partex",
"type": "Business and Industrial Markets",
"location": "stenifs"
},
"organizationUuid": "ORG2111119716"reservationReserved"
}
}
|
