E2ECreate Shipping Rates
POST
/shipping_ratesYamato Takkyubin (Japan)
Request body: CreateShippingRateDTO
Responses: 200, 400
Generated from the code contract; no hand-written description yet.
Request
Example
curl -X POST 'https://api.paycose.com/api/v1/app1/platform/wallet/shipping_rates/' \
-H 'X-Session-Token: {{session_token}}' \
-H 'X-Country: {{country}}' \
-H 'X-Test-Mode: {{x_test_mode}}' \
-d '{
"display_name": "Yamato Takkyubin (Japan)",
"type": "fixed_amount",
"active": true,
"currency": "JPY",
"amount": 800,
"tax_behavior": "inclusive",
"tax_code": "",
"delivery_estimate": {
"minimum": {
"unit": "business_day",
"value": 1
},
"maximum": {
"unit": "business_day",
"value": 2
}
},
"metadata": {
"courier": "Yamato Transport"
},
"labels": [
"<string>"
]
}'Headers
| Name | Value | Description |
|---|---|---|
| X-Session-Token | {{session_token}} | |
| X-Country | {{country}} | |
| X-Test-Mode | {{x_test_mode}} | true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request. |
Body
| Name | Type | Value |
|---|---|---|
| display_name | string | Yamato Takkyubin (Japan) |
| type | string | fixed_amount |
| active | boolean | true |
| currency | string | JPY |
| amount | number | 800 |
| tax_behavior | string | inclusive |
| tax_code | string | |
| delivery_estimate | object | {…} |
| metadata | object | {…} |
| labels | array | [1] |
{
"display_name": "Yamato Takkyubin (Japan)",
"type": "fixed_amount",
"active": true,
"currency": "JPY",
"amount": 800,
"tax_behavior": "inclusive",
"tax_code": "",
"delivery_estimate": {
"minimum": {
"unit": "business_day",
"value": 1
},
"maximum": {
"unit": "business_day",
"value": 2
}
},
"metadata": {
"courier": "Yamato Transport"
},
"labels": [
"<string>"
]
}Responses
200200 OK
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"id": "<string>",
"object": "<string>",
"resource": "<string>",
"created_at": "<RFC3339 timestamp>",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"next_action": [
{
"type": "<string>",
"title": "<string>",
"description": "<string>",
"i18n_key": "<string>",
"url": "<string>",
"client_secret": "<string>",
"payment_method": "<string>",
"qr_data": "<string>"
}
]
}400400 Bad Request
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"object": "error",
"code": "<string>",
"key": "<string>",
"i18n_key": "<string>",
"message": "<string>",
"request_id": "<string>"
}