Customer Sales V2
POST /v2/customer-sales
Description
Endpoint for creating customer sales transactions with detailed order and payment information.
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| tenantId* | string |
| countryCode* | string |
Request Body
{
"customerId": "string",
"customerBusinessId": "string",
"deliveryAddressId": "string",
"agentId": "string",
"deliveryNote": "string",
"eftAttachment": "string",
"newDeliveryAddress": {
"state": "string",
"city": "string",
"address": "string",
"longitude": 0,
"latitude": 0,
"postalCode": "string",
"deliveryMode": "PICK_UP",
"customerPhoneNumber": "string"
},
"isInStore": true,
"discountType": "FIXED",
"discount": 0,
"deliveryMode": "PICK_UP",
"paymentMode": "IN_STORE",
"paymentMethod": "QR",
"extraPayloads": {
"ussdString": "string",
"bankCode": "string",
"accountNumber": "string",
"paymentLink": "string",
"navigatingUrl": "string",
"qrCode": "string"
},
"orders": [
{
"productId": "string",
"quantity": 0
}
],
"inStore": true
}
Responses
Response Code: 200 - OK
Description Successful creation of customer sales transaction.
Response Body
{
"message": "string",
"data": {
"transactionReference": "string",
"totalAmount": 0,
"globalOrderNumber": "string",
"paymentStatus": "PENDING",
"paymentMethod": "QR",
"extraPayloads": {
"ussdString": "string",
"bankCode": "string",
"accountNumber": "string",
"paymentLink": "string",
"navigatingUrl": "string",
"qrCode": "string"
},
"sales": [
{
"id": "string",
"totalAmount": 0,
"discount": 0,
"shippingFee": 0,
"orderAmount": 0,
"totalVat": 0,
"totalVatRatio": 0,
"requestId": "string",
"merchantId": "string",
"paymentMethod": "QR",
"paymentMode": "IN_STORE",
"paymentStatus": "PENDING",
"deliveryMode": "PICK_UP",
"deliveryStatus": "PENDING",
"orderNumber": "string",
"totalQuantity": 0,
"deliveryAddress": "string",
"customer": {
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"city": {
"code": "string",
"name": "string"
},
"phone": "string",
"profileTenant": "string",
"photo": "string",
"get_id": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"status": "string",
"profileOwners": [
"string"
],
"businesses": [
{
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
}
],
"address": "string",
"fullName": "string"
},
"agent": {
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"city": {
"code": "string",
"name": "string"
},
"phone": "string",
"profileTenant": "string",
"photo": "string",
"get_id": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"status": "string",
"profileOwners": [
"string"
],
"businesses": [
{
"get_id": "string",
"name": "string",
"email": "string",
"photo": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"address": {
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0
},
"location": {
"coordinates": [
0
],
"type": "string"
},
"user": "string",
"owner": {
"profileTenant": "string",
"city": {
"code": "string",
"name": "string"
},
"country": {
"code": "string",
"name": "string",
"currency": "string"
},
"firstName": "string",
"lastName": "string",
"phone": "string",
"photo": "string",
"state": {
"code": "string",
"name": "string"
},
"username": "string",
"wallet": {
"userId": "string",
"virtualBankCode": "string",
"floatAccountId": "string",
"floatAccountUuid": "string",
"floatAccountNumber": "string",
"commissionAccountId": "string"
},
"id": "string",
"fullName": "string"
},
"businessHandle": "string",
"shippingFee": 0,
"phone": "string",
"category": "string",
"active": true,
"acceptingOrder": true,
"isDistributor": true,
"isManufacturer": true,
"isHead": true,
"extraLocationPrice": 0,
"distance": 0,
"kycDetails": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"pickUpAddresses": [
{
"country": "string",
"latitude": 0,
"lga": "string",
"name": "string",
"state": "string",
"longitude": 0,
"location": {
"coordinates": [
0
],
"type": "string"
}
}
],
"priceMargin": {
"type": "FIXED",
"source": "BUSINESS",
"value": 0,
"enabled": true
}
}
],
"address": "string",
"fullName": "string"
},
"isCartOrder": true,
"id": "string",
"get_id": "string",
"status": "string",
"date": "2024-07-17T00:00:00.000Z",
"updatedAt": "2024-07-17T00:00:00.000Z",
"orders": [
{
"productId": "string",
"quantity": 0,
"name": "string",
"unitPrice": 0,
"amount": 0,
"discount": 0,
"shippingFee": 0,
"orderAmount": 0,
"totalVat": 0,
"totalVatRatio": 0,
"product": {
"categoryId": "string",
"unitPrice": 0,
"totalAmount": 0,
"totalPrice": 0,
"totalVatRatio": 0,
"totalVat": 0,
"category": "string",
"productId": "string",
"get_id": "string",
"status": "string",
"name": "string",
"description": "string",
"subCategory": "string",
"specifications": [
{
"product_id": "string",
"get_id": "string",
"name": "string",
"units": 0,
"unitPrice": 0,
"totalPrice": 0,
"discount": 0,
"shippingFee": 0,
"totalVatRatio": 0,
"totalVat": 0
}
],
"deliveryNote": "string",
"token": "string",
"image": "string",
"deliveryAddress": "string",
"deliveryMode": "PICK_UP",
"sales": [
{
"product_id": "string",
"get_id": "string",
"name": "string",
"total_amount": 0,
"total_quantity": 0,
"orderAmount": 0,
"discount": 0,
"shippingFee": 0,
"totalVat": 0,
"totalVatRatio": 0,
"deliveryAddress": "string",
"unitPrice": 0,
"deliveryNote": "string",
"image": "string",
"deliveryMode": "PICK_UP",
"totalPrice": 0,
"token": "string",
"status": "string"
}
],
"extraPayloads": {
"ussdString": "string",
"bankCode": "string",
"accountNumber": "string",
"paymentLink": "string",
"navigatingUrl": "string",
"qrCode": "string"
},
"orders": [
{
"product_id": "string",
"get_id": "string",
"name": "string",
"total_amount": 0,
"total_quantity": 0,
"orderAmount": 0,
"discount": 0,
"shippingFee": 0,
"totalVat": 0,
"totalVatRatio": 0,
"deliveryAddress": "string",
"unitPrice": 0,
"deliveryNote": "string",
"image": "string",
"deliveryMode": "PICK_UP",
"totalPrice": 0,
"token": "string",
"status": "string"
}
]
}
}
]
}
]
}
}
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
🔑 Authentication bearer
| Param | Value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request POST \
--url /v2/customer-sales \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!