Skip to content
Browse documentation

API reference

Shipping

List the shipping methods a project offers so a shopper can choose one before checkout.

Feature requirement: the project must have the commerce feature enabled, or these endpoints return 404.

GET/api/v1/storefront/projects/{project_slug}/shipping-methods

Public Methods

Parameters
NameTypeInDescription
project_slugstringpathRequired.
subtotal_minorintegerqueryOptional.
Response 200 (list) · ShippingMethodRead[]
FieldTypeDescription
namestringrequired—
codestringrequired—
descriptionstring (nullable)optional—
price_minorintegeroptional—
currencystringoptional—
min_order_minorinteger (nullable)optional—
max_order_minorinteger (nullable)optional—
requires_addressbooleanoptional—
is_activebooleanoptional—
idstringrequired—
project_idstringrequired—
created_atstring<date-time>required—
updated_atstring<date-time>required—
Example request
curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/shipping-methods" \
  -H "X-Project-Key: wt_pk_your_key"

← All resource groups