Receive Price

Production

https://api.b2b.retter.io/5p1hp1d2t

POST

/CALL/MerchantStockPriceImporter/receivePrice/{B2B_MERCHANT_PROJECT_ID}

Last modified:2024-09-17 11:22:35

This function is responsible for receiving incoming price updates for a merchant's products. It conveys the products to MerchantStockPriceImporter, which checks if the received channels are valid for the merchant and process the stock updates in its unique state.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

B2B_MERCHANT_PROJECT_ID

string

required

Header Params

x-api-key

string

optional

Body Params application/json

frequency

integer

optional

When bulk stock and price submissions create excessive load, the frequency value can be used to slow down the pushStock/pushPrice operations within each 500-unit batch. It takes values between 0 and 10 in seconds.
For example: If you set it to 1, it will introduce a 1-second delay between each push operation, completing the pushStock operations in approximately 500 seconds in total when sending 1.

bulkOperationId

string

optional

All of the bulk stock/price submissions are tracked with the same operation ID, allowing batch operations to be monitored collectively with this ID. A batchId is created for every five hundred-unit batch. The bulkOperationId should be the same for all five-hundred-unit batches sent at the same time.
For example, if you have sent 10 receivePrice requests for 5000 products, all of them should have the same bulkOperationId.

items

array [object {4}]

optional

prices

array [object {4}]

optional

sku

string

required

warehouseCode

string

required

channel

string

optional

Example

{
    "frequency": 0,
    "bulkOperationId": "string",
    "items": [
        {
            "prices": [
                {
                    "priceType": "string",
                    "price": 0,
                    "startDate": "string",
                    "endDate": "string"
                }
            ],
            "sku": "string",
            "warehouseCode": "string",
            "channel": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/MerchantStockPriceImporter/receivePrice/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "frequency": 0,
    "bulkOperationId": "string",
    "items": [
        {
            "prices": [
                {
                    "priceType": "string",
                    "price": 0,
                    "startDate": "string",
                    "endDate": "string"
                }
            ],
            "sku": "string",
            "warehouseCode": "string",
            "channel": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

batchId

string

required

bulkOperationId

string

optional

frequency

integer

optional

Example

{
    "batchId": "string",
    "bulkOperationId": "string",
    "frequency": 0
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2024-09-17 11:22:35

Receive Stock

Get Stock/Price History