Customer Cancel Sale

POST {{baseUrl}}/customer-sales/cancel/:saleId

Description

Customer Cancel Sale

Request

• Headers:
  • (Required) tenantId
  • Content-Type: application/json
• URL: /customer-sales/cancel/:saleId
• Variable:
  • saleId

Response

• Status: OK (200)
• Headers:
  • tenantId (Required)
  • Content-Type: application/json
  • Accept: */*

Path Variables

• saleId

Sample Request

curl --location -g '{{baseUrl}}/customer-sales/cancel/:saleId' \
--header 'tenantId: <string>' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "customerId": "<string>",
  "deliveryStatus": "RETURNED",
  "saleId": "<string>",
  "comment": {
    "comment": "<string>",
    "commentStatus": "OPEN",
    "commentedBy": "<string>",
    "saleId": "<string>",
    "status": "RETURN_CONFIRMED"
  }
}'

Sample Response

{
  "message": "<string>",
  "data": {
    "id": "<string>",
    "tenantId": "<string>",
    "merchantId": "<string>",
    "businessId": "<string>",
    "agentId": "<string>",
    "customerId": "<string>",
    "transactionReference": "<string>",
    "paymentReference": "<string>",
    "totalAmount": "<double>",
    "discount": "<double>",
    "amountPaid": "<double>",
    "orderNumber": "<string>",
    "globalOrderNumber": "<string>",
    "totalQuantity": "<integer>",
    "paymentMethod": "<string>",
    "paymentStatus": "<string>",
    "deliveryAddress": "<string>",
    "paymentMode": "<string>",
    "deliveryMode": "<string>",
    "deliveryStatus": "<string>",
    "deliveryNote": "<string>",
    "orders": [
      {
        "productImage": [
          "<string>",
          "<string>"
        ],
        "name": "<string>",
        "id": "<string>",
        "brand": "<string>",
        "quantity": "<integer>",
        "unitPrice": "<double>",
        "amount": "<double>",
        "promotionDiscount": "<double>",
        "sellingPrice": "<double>",
        "costPrice": "<double>",
        "totalCostPrice": "<double>",
        "profit": "<double>"
      }
    ],
    "salesTracking": [
      {
        "id": "<string>",
        "deliveryStatus": "DELIVERED",
        "saleId": "<string>",
        "isDelayed": "<boolean>",
        "merchantId": "<string>",
        "bussinessId": "<string>",
        "tenantId": "<string>",
        "createdAt": "<dateTime>",
        "updatedAt": "<dateTime>"
      }
    ],
    "isPartial": "<boolean>",
    "isPartialParent": "<boolean>",
    "createdAt": "<dateTime>",
    "updatedAt": "<dateTime>",
    "business": {
      "get_id": "<string>",
      "name": "<string>",
      "photo": "<string>",
      "wallet": {
        "consectetur_f2_": {},
        "inc1f": {},
        "dolor48c": {}
      },
      "address": {
        "country": "<string>",
        "latitude": "<integer>",
        "lga": "<string>",
        "name": "<string>",
        "state": "<string>",
        "longitude": "<integer>"
      }
    },
    "customer": {
      "country": {
        "code": "<string>",
        "name": "<string>",
        "currency": "<string>"
      },
      "firstName": "<string>",
      "lastName": "<string>",
      "wallet": {
        "virtualBankCode": "<long>"
      },
      "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>",
        "<string>"
      ],
      "address": "<string>",
      "fullName": "<string>"
    },
    "agent": {
      "country": {
        "code": "<string>",
        "name": "<string>",
        "currency": "<string>"
      },
      "firstName": "<string>",
      "lastName": "<string>",
      "wallet": {
        "virtualBankCode": "<long>"
      },
      "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>",
        "<string>"
      ],
      "address": "<string>",
      "fullName": "<string>"
    }
  },
  "meta": {
    "currentPage": "<long>",
    "from": "<long>",
    "to": "<long>",
    "perPage": "<long>",
    "total": "<long>",
    "lastPage": "<long>"
  }
}