OTotto
ShippingProfiles V1

Create shipping profile

This POST API endpoint is to create shipping profile API POST will always create a new shipping profile after ensuring it is not a duplicate for a partner.

post/v1/shipping-profiles

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v1/shipping-profiles
  • Auth
    HTTP bearer

Headers

Authorizationstring required

Access Token

Request body

shippingProfileNamestring required

ShippingProfileName allows the partner to assign a descriptive and unique name for a shipping profile

workingDaysstring[] required

WorkingDays describe the specific days of the week on which the partner is available to process orders

orderCutoffstring HH:MM required

OrderCutoff specifies the time for orders to be placed, so the ProcessingTime starts within the same day. <br> This must be in half hour duration in (HH:MM) 24 hours format. The cut-off time must be specified in CET time.

deliveryType'PARCEL' | 'FORWARDER_PREFERREDLOCATION' | 'FORWARDER_CURBSIDE' | 'FORWARDER_HEAVYDUTY' required

DeliveryType describes how the product is being shipped. At the moment we support the enums shown above

defaultProcessingTimeinteger required

DefaultProcessingTime describes the time the partner needs to prepare the order for a shipment. Must be between 1 to 99. <br> If more than 72 days are transmitted in the DefaultProcessingTime, the product is marked as sold out on otto.de and cannot be ordered. <br> This is also the case if the DefaultProcessingTime and TransportTime add up to a value greater than 72. "1" day is considered as same-day shipping (0 days) until the cut-off time is reached.

transportTimeinteger required

TransportTime describes the time the carrier needs from collecting the order from partners warehouse until the first delivery attempt. Must be between 1 to 99. <br> If more than 72 days are transmitted in the TransportTime, the product is marked as sold out on otto.de and cannot be ordered. <br> This is also the case if the DefaultProcessingTime and TransportTime add up to a value greater than 72.

Example request

{
  "shippingProfileName": "TestShippingProfile",
  "workingDays": [
    "MONDAY",
    "WEDNESDAY"
  ],
  "orderCutoff": "23:30",
  "deliveryType": "PARCEL",
  "defaultProcessingTime": 2,
  "transportTime": 2
}

Response

Created

shippingProfileIdstring required

Unique identifier for each shipping profile id

messagestring required

successful message

Example response

{
  "shippingProfileId": "38427776-7383-4d65-82c9-dbe949d0573a",
  "message": "Shipping profile created successfully with id : 38427776-7383-4d65-82c9-dbe949d0573a"
}

Changes

No recorded changes to this operation across all 10 revisions of this API.