Skip to main content

Update Product Details (v2)

PATCH /api/v2/products/{productId}

Description

Update details of a product.

Path Parameters

NameTypeDescription
productIdstringThe ID of the product to update (path)

Request Headers

NameTypeDescription
tenantIdstringThe tenant ID (header)
userIdstringThe user ID (header)
countryCodestringThe country code (header)

Request Body

  • Content Type: application/json
{
"productTypeId": "string",
"quantity": 0,
"productUnitType": "Barrels",
"state": "string",
"city": "string",
"address": "string",
"deliveryCapacity": {
"quantity": 0,
"productUnitType": "Barrels",
"frequency": "HOURS"
},
"businessId": "string",
"userId": "string",
"tenantId": "string",
"countryCode": "string"
}

Response Code: 200 - OK

Description

No specific links.

Example Response

No specific response structure defined.

Method: PATCH

>http://your-api-url/api/v2/products/{productId}

Headers

Content-TypeValue
apiKey{{apiKey}}
tenantIdstring
userIdstring
countryCodestring

Body

{
"productTypeId": "prod123",
"quantity": 100,
"productUnitType": "Barrels",
"state": "California",
"city": "Los Angeles",
"address": "123 Main St",
"deliveryCapacity": {
"quantity": 50,
"productUnitType": "Barrels",
"frequency": "HOURS"
},
"businessId": "biz456",
"userId": "usr789",
"tenantId": "tenant123",
"countryCode": "US"
}

🔑 Authentication bearer

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v2/products/{productId} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


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