Create shipping method

post

https://api.indicaonline.com/open_api/v2.5/shipping-methods

Create a shipping method. Required: name, type, slot_periods. Delivery zone comes from kml_file_id (POST /open_api/v1/file/upload); it is required for delivery and mail methods with is_sweede=true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

length ≤ 100

type

string

enum

Allowed:

price

float

≥ 0

is_active

boolean

is_sweede

boolean

free_delivery

object

min_order

object

restrict_end_time

integer

enum

Minutes before the end of the order processing window when ordering stops. Applies to delivery and mail only; ignored and stored as 0 for pickup.

Allowed:

slot_periods

array of objects

length between 1 and 12

slot_periods

start_time

string

required

HH:MM, 15-minute steps

end_time

string

required

HH:MM, 15-minute steps; may cross midnight

duration

integer

required

≥ 1

next_available_time

integer

≥ 0

Defaults to company settings

average_eta

integer

≥ 1

Defaults to company settings

kml_file_id

integer | null

File id from POST /open_api/v1/file/upload; null removes the zone

Responses

400

Body is not a JSON object

422

Validation failed

503

Shipping service is unavailable

Language

Credentials

Header

Loading…

Response

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

application/json

201Created