curl --request PATCH \
--url https://panel.sendcloud.sc/api/v3/shipping-defaults \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"weight": {
"value": "1.500",
"unit": "kg"
}
}
'{
"data": {
"weight": {
"value": "1.500",
"unit": "kg"
},
"ship_with": {
"type": "shipping_method_id",
"properties": {
"shipping_method_id": 8
}
},
"insurance": {
"type": "percentage",
"properties": {
"percentage": 100
}
},
"customs_options": {
"export_reason": "commercial_goods",
"use_order_number_as_invoice_number": false
},
"label_options": {
"label_notes": [
"order_reference"
],
"show_qr_code_letter": true,
"show_port_letter": false
}
}
}{
"errors": [
{
"status": "400",
"code": "invalid",
"detail": "This shipping method is not compatible with your default weight.",
"source": {
"pointer": "/ship_with/properties/shipping_method_id"
}
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Update your shipping defaults
Update the shipping defaults configured for your account.
Only the fields you send are changed; anything you omit keeps its current value. Send null for ship_with or insurance to remove that default.
curl --request PATCH \
--url https://panel.sendcloud.sc/api/v3/shipping-defaults \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"weight": {
"value": "1.500",
"unit": "kg"
}
}
'{
"data": {
"weight": {
"value": "1.500",
"unit": "kg"
},
"ship_with": {
"type": "shipping_method_id",
"properties": {
"shipping_method_id": 8
}
},
"insurance": {
"type": "percentage",
"properties": {
"percentage": 100
}
},
"customs_options": {
"export_reason": "commercial_goods",
"use_order_number_as_invoice_number": false
},
"label_options": {
"label_notes": [
"order_reference"
],
"show_qr_code_letter": true,
"show_port_letter": false
}
}
}{
"errors": [
{
"status": "400",
"code": "invalid",
"detail": "This shipping method is not compatible with your default weight.",
"source": {
"pointer": "/ship_with/properties/shipping_method_id"
}
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"id": "<string>",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "unknown_field",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Body
The shipping defaults to change. Every field is optional; anything you omit keeps its current value.
The default weight of a parcel. Only kg is supported, with up to three decimal places.
Show child attributes
Show child attributes
The shipping method to apply by default. Send null to remove the default.
Show child attributes
Show child attributes
The insurance to apply by default. Send null to remove the default.
- PercentageInsurance
- FixedAmountInsurance
Show child attributes
Show child attributes
The customs defaults to change. Every field is optional.
Show child attributes
Show child attributes
The label defaults to change. Every field is optional.
Show child attributes
Show child attributes
Response
OK
The shipping defaults configured for your account.
The default values that are applied to your shipments.
Show child attributes
Show child attributes