Creates a freight method

post

https://hub.omniplat.io/v1/clients/{clientId}/freight/methods

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client identificator

Body Params

string

required

Can be any string value. If is 'SCHEDULE', then is required to define 'schedule' object.

clientId

string

required

name

string

required

billingDeadline

number

deadlineTime

string

allowAfterDeadline

boolean | null

active

boolean

Defaults to true

isLocker

boolean

Defaults to false

poolDeadline

integer | null

≥ 0

disableFulfillmentSplit

boolean

Defaults to false

isScheduled

boolean

Defaults to false

isPoolEnabled

boolean

Defaults to false

isFulfillmentStealEnabled

boolean

Defaults to false

freightPriorities

array of strings

freightPriorities

Allowed:

macroregionPriorities

object

Available macroregion priorizations (fallback: use all locations)

enableLocationsPriority

object

schedule

object | null

Required schedule params when FreightMethod has isScheduled=true

fullReallocation

object | null

Full Reallocation config

useRecess

string | null

enum

Allowed:

Responses

201

Resource created with success

400

Wrong parameters were sent on the request

401

User not authorized

409

Resource already exists

500

Internal Server Error

Language

Loading…

Response

Click Try It! to start a request and see the response here!