OTotto
ShippingProfiles V1

Get shipping profile by shipping profile id

This GET API endpoint is to get a shipping profile of the partner by shipping profile id.

get/v1/shipping-profiles/{shippingProfileId}

Request

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

Path parameters

shippingProfileIdstring required
Example:7bec0ef6-4324-4fa4-9fbf-42c54659ef04

The id of the shipping profile in uuid4 format and the primaryKey for mapping a Profile to a SKU

Headers

Authorizationstring required

Access Token

Response

The shipping profile details of the partner </br>1. specific shipping profile for the given shippingProfileId

shippingProfileIdstring required

Unique identifier for each shipping profile

shippingProfileNamestring required

The name of the shipping profile

workingDaysstring[] required

The days of the week on which the partner is available to process orders

orderCutoffstring HH:MM, 24 hours format, CET timezone 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 and 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.

transportTimeinteger required

The time the carrier needs from collecting the order from partners warehouse till the first delivery attempt.

Example response

{
  "shippingProfileId": "38427776-7383-4d65-82c9-dbe949d0573a",
  "shippingProfileName": "TestShippingProfile",
  "workingDays": [
    "MONDAY",
    "WEDNESDAY"
  ],
  "orderCutoff": "23:30",
  "deliveryType": "PARCEL",
  "defaultProcessingTime": 2,
  "transportTime": 2
}

Changes

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