Create an order template

post

https://example.com/integration-tenants/api/v1/order-templates

Create a new order template. Note that Basic Authentication is required for all requests as such, make sure to provide the Authorization header with a valid value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

templateName

string

required

length between 0 and 128

isForRecurringOrder

boolean

isForCsrStandaloneOrder

boolean

isForSelfserveStandaloneOrder

boolean

canBeModifiedBySelfserve

boolean

preventDeliveryPriceModification

boolean

preventExtraFeesPriceModification

boolean

useInfosFromContactForPickup

boolean

useInfosFromContactForDelivery

boolean

accountId

string

required

length ≥ 1

callerUserId

string

required

length ≥ 1

pickupAddress

object

required

pickupLocation

object

pickupContactInfo

object

pickupNotes

string | null

pickupAddressId

string | null

deliveryAddress

object

required

deliveryLocation

object

deliveryContactInfo

object

deliveryNotes

string | null

deliveryAddressId

string | null

notes

string | null

internalNotes

string | null

serviceLevelId

string | null

vehicleTypeId

string | null

defaultDriverId

string | null

overridePickupAndDeliveryWindow

boolean

pickupFromDayOffset

int32 | null

pickupToDayOffset

int32 | null

pickupFromTime

string | null

pickupToTime

string | null

deliveryFromDayOffset

int32 | null

deliveryToDayOffset

int32 | null

deliveryFromTime

string | null

deliveryToTime

string | null

orderPayout

object

attributeIds

array of strings | null

attributeIds

deliveryChargePrice

double | null

packageValidationOption

int32

enum

[0 - 'NoValidation', 1 - 'PickupOnly', 2 - 'DeliveryOnly', 3 - 'PickupAndDelivery']

Allowed:

extraFees

array of objects | null

extraFees

hubs

array of objects | null

hubs

routeName

string | null

orderProfileId

string | null

pickupDurationInMinutes

int32

0 to 120

deliveryDurationInMinutes

int32

0 to 120

collectOnDelivery

double | null

collectOnPickup

double | null

allowPartialCollectOnDelivery

boolean

allowPartialCollectOnPickup

boolean

requireIdentityValidation

boolean

requireIdentityValidationOnPickup

boolean

generateProofOfDeliveryOnDelivery

boolean | null

referenceNumber1

string | null

referenceNumber2

string | null

referenceNumber3

string | null

workflows

array of objects | null

workflows

userFields

array of objects | null

userFields

items

array of objects | null

items

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

500

An error occurred when trying to create the order template

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200The order template was created successfully

400The request is invalid