Skip to main content

Create Partial Sale

POST {{baseUrl}}/partial-sales

Description​

Create a partial sale by submitting information about products and related details.

Request​

  • Headers:
    • Content-Type: application/json
    • ApiKey: The platform API key is required to use this endpoint - {{PlatformApiKey}}
  • URL: {{baseUrl}}/partial-sales
  • Request Body: JSON data containing user information, including an array of products, tenantId, parentSaleId, and other relevant details.

Response​

  • Status: Created (201)
  • Headers:
    • tenantId (Required)
    • countryCode (Required)
    • Content-Type: application/json
    • Accept: */*

Query Parameters​

  • params (optional)

Sample Request​

curl --location -g '{{baseUrl}}/partial-sales' \
--header 'Content-Type: application/json' \
--header 'ApiKey: {{PlatformApiKey}}' \
--data '{
  "tenantId": "<string>",
  "parentSaleId": "<string>",
  "products": [
    {
      "productId": "<string>",
      "quantity": "<integer>",
      "price": "<double>"
    }
  ],
  "otherDetails": "<string>"
}'

Sample Response​

{
  "message": "Partial sale created successfully",
  "data": {
    "saleId": "<string>",
    "tenantId": "<string>",
    "parentSaleId": "<string>",
    "products": [
      {
        "productId": "<string>",
        "quantity": "<integer>",
        "price": "<double>"
      }
    ],
    "otherDetails": "<string>"
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /partial-sales \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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