API Reference

Create Shipping Option

post
https://marketplace-integrations.nelo.co/v1/admin/shipping-options

Create a Shipping Option.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the shipping option to create.

string
required

The name of the Shipping Option

string
required

The ID of the Region in which the Shipping Option will be available.

string
required

The ID of the Fulfillment Provider that handles the Shipping Option.

number

The ID of the Shipping Profile to add the Shipping Option to.

data
object
required

The data needed for the Fulfillment Provider to handle shipping with this Shipping Option.

string
enum
required

The type of the Shipping Option price. flat_rate indicates fixed pricing, whereas calculated indicates that the price will be calculated each time by the fulfillment provider.

Allowed:
integer

The amount to charge for the Shipping Option. If the price_type is set to calculated, this amount will not actually be used.

requirements
array of objects

The requirements that must be satisfied for the Shipping Option to be available.

requirements
boolean
Defaults to false

Whether the Shipping Option can be used for returns or during checkout.

boolean
Defaults to false

If set to true, the shipping option can only be used when creating draft orders.

metadata
object

An optional set of key-value pairs with additional information.

boolean

Tax included in prices of shipping option

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 11 months ago