Shipping methodΒΆ

An object describing a shipping method.

Field name

Type

Description

uid

String

A machine readable id for this shipping method, used in communication with the API.

name

I18N

The human readable name of the shipping method.

costs

Amount

The costs charged to the consumer for the shipping method.

pickup_location

String

The pick up location when the fulfillment method is PICKUP.

required_consumer_fields

List of String

Optional, the list of required consumer fields to create the order. This field is served only by the Bill endpoint.