Skip to main content

Sales Tracking

GET /sales-tracking​

Parameters​

  • deliveryStatus (string, query, optional): Filters sales by delivery status. Available values include: PENDING, REJECTED, CANCELLED, ACCEPTED, SHIPPED, DELIVERED, CONFIRMED, RETURNED, RETURN_CONFIRMED, READY_TO_SHIP, READY_FOR_PICKUP, PICKING, PACKED.
  • saleId (integer, query, optional): Filters sales by sale ID.
  • isDelayed (boolean, query, optional): Filters sales by delay status.
  • merchantId (string, query, optional): Filters sales by merchant ID.
  • tenantId (string, query, optional): The ID of the tenant.
  • from (string, query, optional): Start date/time filter.
  • to (string, query, optional): End date/time filter.
  • locale.baseLocale.language (string, query, optional): Language filter for locale.
  • locale.baseLocale.script (string, query, optional): Script filter for locale.
  • locale.baseLocale.region (string, query, optional): Region filter for locale.
  • locale.baseLocale.variant (string, query, optional): Variant filter for locale.
  • page (integer, query, optional): One-based page index for pagination. Default value: 1.
  • size (integer, query, optional): Number of items per page. Default value: 20.
  • sort (array[string], query, optional): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Example Value​

{
  "sales": [
    {
      "saleId": 12345,
      "deliveryStatus": "DELIVERED",
      "isDelayed": false,
      "merchantId": "merchant_789",
      "saleDetails": {
        // Details of the sale
      }
    },
    {
      "saleId": 67890,
      "deliveryStatus": "ACCEPTED",
      "isDelayed": true,
      "merchantId": "merchant_123",
      "saleDetails": {
        // Details of the sale
      }
    }
    // More sales objects
  ],
  "pagination": {
    "totalItems": 1000,
    "currentPage": 1,
    "totalPages": 50,
    "itemsPerPage": 20
  }
}

Responses​

200 OK​

  • Media Type: application/json

Example Value​

{
  "message": "string",
  "data": [
    {
      "id": "string",
      "nativeId": 0,
      "tenantId": "string",
      "countryCode": "string",
      "merchantId": "string",
      "businessId": "string",
      "customerBusinessId": "string",
      "agentId": "string",
      "customerId": "string",
      "transactionReference": "string",
      "paymentReference": "string",
      "eftReceipt": "string",
      "totalAmount": 0,
      "orderAmount": 0,
      "shippingFee": 0,
      "shippingFeeDetail": {
        "shippingFee": 0,
        "distanceCovered": 0,
        "requestId": "string",
        "dropOffUserId": "string"
      },
      "logisticsProvider": "string",
      "baseFare": 0,
      "unitPricePerDistance": 0,
      "totalVat": 0,
      "totalVatRatio": 0,
      "discount": 0,
      "amountPaid": 0,
      "orderNumber": "string",
      "globalOrderNumber": "string",
      "totalQuantity": 0,
      "paymentMethod": "string",
      "paymentStatus": "string",
      "deliveryAddress": "string",
      "deliveryAddressDto": {
        "id": "string",
        "state": "string",
        "city": "string",
        "address": "string",
        "latitude": 0,
        "longitude": 0,
        "customerId": "string",
        "tenantId": "string",
        "postalCode": "string",
        "deliveryMode": "PICK_UP",
        "customerPhoneNumber": "string"
      },
      "paymentMode": "string",
      "deliveryMode": "string",
      "deliveryStatus": "string",
      "deliveryNote": "string",
      "orders": [
        {
          "productImage": [
            "string"
          ],
          "name": "string",
          "id": "string",
          "brand": "string",
          "quantity": 0,
          "quantityRemaining": 0,
          "amount": 0,
          "promotionDiscount": 0,
          "sellingPrice": 0,
          "costPrice": 0,
          "totalCostPrice": 0,
          "profit": 0,
          "vat": 0,
          "vatRatio": 0
        }
      ],
      "extraPayloads": {
        "ussdString": "string",
        "bankCode": "string",
        "accountNumber": "string",
        "paymentLink": "string",
        "navigatingUrl": "string",
        "qrCode": "string"
      },
      "salesTracking": [
        {
          "id": "string",
          "deliveryStatus": "PENDING",
          "saleId": "string",
          "isDelayed": true,
          "merchantId": "string",
          "bussinessId": "string",
          "tenantId": "string",
          "createdAt": "2024-07-18T17:19:17.542Z",
          "updatedAt": "2024-07-18T17:19:17.542Z"
        }
      ],
      "isPartial": true,
      "isPartialParent": true,
      "createdAt": "2024-07-18T17:19:17.542Z",
      "updatedAt": "2024-07-18T17:19:17.542Z",
      "deliveryData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "business": {
        "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
        }
      },
      "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"
      },
      "customerBusiness": {
        "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
        }
      },
      "inStore": true
    }
  ],
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /sales-tracking \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!