2.Define Shipping Cost

As with payment at the time of purchase, if you are able to obtain the shipping cost from the shipping provider X days later, you can transmit the relevant cost to PayWall through this service.

Product Shipping Cost Definition

POST {{PaymentBaseAddress}}/api/paywall/product/cargocost

Important: In order to use the Shipping Cost Definition service, you must send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' section.

PaymentAPI Address

Parameter	Type	Required	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

The parameters that need to be sent to the service are as follows:

Parameter	Type	Required	Description
ProductId	int	Yes	Product's ID (Identity) information.
CargoOwnerType	int	Yes	The party responsible for covering the shipping cost. It should be carefully configured, as the shipping cost will be deducted from the earnings of the responsible party. See: CargoOwnerType
CargoCost	decimal	Yes	Shipping cost

Sample to be sent to the service JSON and example code as follows.

JSON

{
    "ProductId": 2113995,
    "CargoOwnerType": 1,
    "CargoCost": 120
}

C#

// Soon

GO

// Soon

Java

// Soon

PHP

// Soon

Python

// Soon

Ruby

// Soon

TypeScript

// Soon

Curl

// Soon

Response from the service:

Parameter	Type	Description
ErrorCode	int	Error code. If the operation is successful, it returns a value of '0'.
Result	bool	It returns a value of 'true' for success and 'false' otherwise.
Message	string	If the operation is unsuccessful, this is the specified error message, providing language support according to the locale parameter.
Body	object	Operation details

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 466721,
        "CurrencyId": 1,
        "CargoOwnerType": 1,
        "CargoCost": 120.00
    }
}