Skip to main content
PUT
/
accounts
/
api
/
costs
/
shipping-settings
curl --request PUT \ --url https://api.upstackdata.com/accounts/api/costs/shipping-settings \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --header 'x-pixel-id: <api-key>' \ --data ' { "method": "fixed_rate", "fixedRateAmount": 7.5, "currency": "USD" } '
{
  "config": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

​
x-pixel-id
string
header
required

The pixel id the request targets.

Body

application/json
​
method
enum<string>
required

Shipping cost attribution method.

  • shopify_charges — use the shipping charge captured on each order.
  • fixed_rate — apply a flat per-order amount (fixedRateAmount required).
  • shipping_profiles — match shipping zones / weights configured in Shopify.
Available options:
shopify_charges,
fixed_rate,
shipping_profiles
​
fixedRateAmount
number

Required when method=fixed_rate. Applied as the per-order shipping cost.

Required range: x >= 0
​
currency
string

ISO currency code (e.g. USD).

Response

The updated shipping configuration.

​
config
object
required