shippingCarrier
POST /shippingCarrier
Changed oncreate a shippingCarrier
Request
- Base URLhttps://www.weclapp.com/api/nullapi/v2
- AuthAPI key in header AuthenticationToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
dryRunboolean
Request body
idstring
versionstring
activeboolean
cashOnDeliveryBankAccountIdstring
cashOnDeliveryCurrencyIdstring
createdDateinteger
declaredValueAmountstring number
declaredValueCurrencyIdstring
dhlGoGreenPlusServiceboolean
dhlPostalDeliveredDutyPaidServiceboolean
dhlPremiumInternationalServiceboolean
ecommerceShippingCarrier'AUSTRIAN_POST' | 'CARGO_INTERNATIONAL' | 'DACHSER' | 'DB_SCHENKER' | 'DEUTSCHE_POST' | 'DHL' | 'DHL_EXPRESS' | 'DPD' | 'FEDEX' | 'GLS' | 'GO' | 'HERMES' | 'ILOXX' | 'KUEHNE_NAGEL' | 'OTHER' | 'PARCEL_ONE' | 'POSTE_ITALIANE' | 'TNT' | 'UPS'
heightinteger
internalShippingCarrier'ANGEL_DE' | 'AUSTRIAN_POST_EMS' | 'AUSTRIAN_POST_PLUS_INTERNATIONAL' | 'AUSTRIAN_POST_PREMIUM' | 'AUSTRIAN_POST_PREMIUM_SELECT' | 'AUSTRIAN_POST_RETURNS' | 'AUSTRIAN_POST_STANDARD' | 'CARGO_INTERNATIONAL_EXPRESS' | 'CARGO_INTERNATIONAL_STANDARD' | 'DEUTSCHE_POST_STANDARD' | 'DHL_1_MAN_HANDLING_RETURN' | 'DHL_2_MAN_HANDLING_RETURN' | 'DHL_COMPLETE_RETURN_PARCEL_CONNECT' | 'DHL_DE_ECOMMERCE_RETURN' | 'DHL_DE_RETOURE' | 'DHL_EUROPAKET' | 'DHL_EUROPAKET_EV' | 'DHL_EXPRESS_ECONOMY_SELECT' | 'DHL_EXPRESS_ONE_DAY' | 'DHL_EXPRESS_ONE_DAY_EARLY' | 'DHL_KLEINPAKET' | 'DHL_KLEINPAKET_EV' | 'DHL_PAKET_EV' | 'DHL_PAKET_INTERNATIONAL_EV' | 'DHL_RETURNS' | 'DHL_RETURNS_EV' | 'DHL_STANDARD' | 'DHL_WARENPOST' | 'DHL_WARENPOST_INTERNATIONAL_EV' | 'DPD_AT_RETURN_RETURN' | 'DPD_CLASSIC_RETURN' | 'DPD_EXPRESS_ONE_DAY' | 'DPD_EXPRESS_ONE_DAY_EARLY' | 'DPD_LOCAL_RETURN' | 'DPD_RETURN' | 'DPD_RETURNS' | 'DPD_STANDARD' | 'FEDEX_DOMESTIC_RETURN' | 'FEDEX_EUROPE_RETURN' | 'FEDEX_EXPRESS_ONE_DAY_EARLY' | 'FEDEX_INTERNATIONALCONNECT_RETURNS' | 'FEDEX_INTERNATIONAL_ECONOMY' | 'FEDEX_INTERNATIONAL_ECONOMY_RETURNS' | 'FEDEX_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_PRIORITY_RETURNS' | 'FEDEX_PRIORITY_RETURNS' | 'FEDEX_STANDARD' | 'FEDEX_STANDARD_RETURNS' | 'GLS_DE_BUSINESS_PARCEL_RETURN' | 'GLS_DE_EUROBUSINESS_RETURN' | 'GLS_ES_BUSINESSSMALLPARCEL_RETURN' | 'GLS_EU_RETURN' | 'GLS_EXPRESS_ONE_DAY' | 'GLS_PICK_AND_SHIP' | 'GLS_RETURNS' | 'GLS_STANDARD' | 'GO_ONE_DAY' | 'HERMES_DE_RETURN' | 'HERMES_RETURNS' | 'HERMES_STANDARD' | 'ILOXX_STANDARD' | 'PARCEL_ONE' | 'POSTNL_PAKJEGEMAK' | 'POSTNL_PAKJEGEMAK_AGECHECK_18' | 'POSTNL_SMALL_HOME_ADDRESS_ONLY_SIGNATURE' | 'POSTNL_SMALL_SIGNATURE' | 'POSTNL_STANDARD_HOME_ADDRESS_ONLY_SIGNATURE' | 'POSTNL_STANDARD_HOME_ADDRESS_ONLY_SIGNATURE_EVE' | 'POSTNL_STANDARD_SIGNATURE' | 'SENDCLOUD_LETTERRETURN' | 'TNT_ONE_DAY' | 'TNT_ONE_DAY_EARLY' | 'UPS_EXPEDITED' | 'UPS_EXPRESS_1200' | 'UPS_EXPRESS_ONE_DAY' | 'UPS_EXPRESS_ONE_DAY_EARLY' | 'UPS_EXPRESS_SAVER_RETURN' | 'UPS_RETURNS' | 'UPS_STANDARD' | 'UPS_STANDARD_RETURN'
lastModifiedDateinteger
lengthinteger
namestring required
packagingWeightstring number
positionNumberinteger
saturdayDeliveryboolean
sendcloudContractIdstring
sendcloudContractNamestring
shippingCarrierAdditionstring
shippingLabelsCountinteger
shippingServiceProviderType'DHL' | 'SENDCLOUD' | 'SHIPCLOUD' | 'STANDARD' required
trackingUrlstring
widthinteger
Response
shippingCarrier create response
idstring
versionstring
activeboolean
cashOnDeliveryBankAccountIdstring
cashOnDeliveryCurrencyIdstring
createdDateinteger
declaredValueAmountstring number
declaredValueCurrencyIdstring
dhlGoGreenPlusServiceboolean
dhlPostalDeliveredDutyPaidServiceboolean
dhlPremiumInternationalServiceboolean
ecommerceShippingCarrier'AUSTRIAN_POST' | 'CARGO_INTERNATIONAL' | 'DACHSER' | 'DB_SCHENKER' | 'DEUTSCHE_POST' | 'DHL' | 'DHL_EXPRESS' | 'DPD' | 'FEDEX' | 'GLS' | 'GO' | 'HERMES' | 'ILOXX' | 'KUEHNE_NAGEL' | 'OTHER' | 'PARCEL_ONE' | 'POSTE_ITALIANE' | 'TNT' | 'UPS'
heightinteger
internalShippingCarrier'ANGEL_DE' | 'AUSTRIAN_POST_EMS' | 'AUSTRIAN_POST_PLUS_INTERNATIONAL' | 'AUSTRIAN_POST_PREMIUM' | 'AUSTRIAN_POST_PREMIUM_SELECT' | 'AUSTRIAN_POST_RETURNS' | 'AUSTRIAN_POST_STANDARD' | 'CARGO_INTERNATIONAL_EXPRESS' | 'CARGO_INTERNATIONAL_STANDARD' | 'DEUTSCHE_POST_STANDARD' | 'DHL_1_MAN_HANDLING_RETURN' | 'DHL_2_MAN_HANDLING_RETURN' | 'DHL_COMPLETE_RETURN_PARCEL_CONNECT' | 'DHL_DE_ECOMMERCE_RETURN' | 'DHL_DE_RETOURE' | 'DHL_EUROPAKET' | 'DHL_EUROPAKET_EV' | 'DHL_EXPRESS_ECONOMY_SELECT' | 'DHL_EXPRESS_ONE_DAY' | 'DHL_EXPRESS_ONE_DAY_EARLY' | 'DHL_KLEINPAKET' | 'DHL_KLEINPAKET_EV' | 'DHL_PAKET_EV' | 'DHL_PAKET_INTERNATIONAL_EV' | 'DHL_RETURNS' | 'DHL_RETURNS_EV' | 'DHL_STANDARD' | 'DHL_WARENPOST' | 'DHL_WARENPOST_INTERNATIONAL_EV' | 'DPD_AT_RETURN_RETURN' | 'DPD_CLASSIC_RETURN' | 'DPD_EXPRESS_ONE_DAY' | 'DPD_EXPRESS_ONE_DAY_EARLY' | 'DPD_LOCAL_RETURN' | 'DPD_RETURN' | 'DPD_RETURNS' | 'DPD_STANDARD' | 'FEDEX_DOMESTIC_RETURN' | 'FEDEX_EUROPE_RETURN' | 'FEDEX_EXPRESS_ONE_DAY_EARLY' | 'FEDEX_INTERNATIONALCONNECT_RETURNS' | 'FEDEX_INTERNATIONAL_ECONOMY' | 'FEDEX_INTERNATIONAL_ECONOMY_RETURNS' | 'FEDEX_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_PRIORITY_RETURNS' | 'FEDEX_PRIORITY_RETURNS' | 'FEDEX_STANDARD' | 'FEDEX_STANDARD_RETURNS' | 'GLS_DE_BUSINESS_PARCEL_RETURN' | 'GLS_DE_EUROBUSINESS_RETURN' | 'GLS_ES_BUSINESSSMALLPARCEL_RETURN' | 'GLS_EU_RETURN' | 'GLS_EXPRESS_ONE_DAY' | 'GLS_PICK_AND_SHIP' | 'GLS_RETURNS' | 'GLS_STANDARD' | 'GO_ONE_DAY' | 'HERMES_DE_RETURN' | 'HERMES_RETURNS' | 'HERMES_STANDARD' | 'ILOXX_STANDARD' | 'PARCEL_ONE' | 'POSTNL_PAKJEGEMAK' | 'POSTNL_PAKJEGEMAK_AGECHECK_18' | 'POSTNL_SMALL_HOME_ADDRESS_ONLY_SIGNATURE' | 'POSTNL_SMALL_SIGNATURE' | 'POSTNL_STANDARD_HOME_ADDRESS_ONLY_SIGNATURE' | 'POSTNL_STANDARD_HOME_ADDRESS_ONLY_SIGNATURE_EVE' | 'POSTNL_STANDARD_SIGNATURE' | 'SENDCLOUD_LETTERRETURN' | 'TNT_ONE_DAY' | 'TNT_ONE_DAY_EARLY' | 'UPS_EXPEDITED' | 'UPS_EXPRESS_1200' | 'UPS_EXPRESS_ONE_DAY' | 'UPS_EXPRESS_ONE_DAY_EARLY' | 'UPS_EXPRESS_SAVER_RETURN' | 'UPS_RETURNS' | 'UPS_STANDARD' | 'UPS_STANDARD_RETURN'
lastModifiedDateinteger
lengthinteger
namestring required
packagingWeightstring number
positionNumberinteger
saturdayDeliveryboolean
sendcloudContractIdstring
sendcloudContractNamestring
shippingCarrierAdditionstring
shippingLabelsCountinteger
shippingServiceProviderType'DHL' | 'SENDCLOUD' | 'SHIPCLOUD' | 'STANDARD' required
trackingUrlstring
widthinteger
Changes
- info
added the new optional
queryrequest parameterdryRun
- info