Parameters
1 path · JSON body
Path parameters
· 1externalIdstringRequiredExample
example_externalIdRequest body
application/jsoncodestringRequiredLength: 1–100
namestringRequiredLength: 1–150
descriptionstring | nullOptionalOne of 2:
Variant 1
string
Variant 2
null
audience"all" | "retail" | "wholesale" | "group"RequiredisVisiblebooleanOptionalisDefaultbooleanOptionalisActivebooleanOptionalsortOrderstring | integerOptionalOne of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 0–∞
freeShippingEligiblebooleanOptionallegacyPricenumberOptionalRange: 0–∞
carrierIdstring | integer | nullOptionalOne of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
Variant 2
null
carrierServiceIdstring | integer | nullOptionalOne of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
Variant 2
null
defaultCarrierConfigurationExternalIdstring | nullOptionalPublic id of the carrier API account (shop__carrier_configuration.external_id) preselected when a shipment is created for an order with this shipping method. Must belong to the method carrier. NULL clears it; omitted keeps the current value (cleared automatically when the carrier changes).
One of 2:
Variant 1
string
Length: 1–16
Variant 2
null
logoBlobIdstring | integer | nullOptionalOne of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
Variant 2
null
translationsobject[]OptionalEach array item:
localeIdstring | integerRequiredOne of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
namestringRequiredLength: 1–∞
descriptionstring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
paymentMethodIdsstring | integer[]OptionalEach array item:
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
contactGroupIdsstring | integer[]OptionalEach array item:
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞
shippingClassIdsstring | integer[]OptionalEach array item:
string | integer
One of 2:
Variant 1
stringinteger
Default:
0Variant 2
integer
Range: 1–∞