v2

latestOpenAPI 3.0.32026-08-05174296703.4 KB
ops

create shipping-method-ops

Create a new shipping method for a seller

post/ops/shipping-method

Request body

is_in_store_pickupboolean

Is this shipping method in store pickup?

namestring

Name for the shipping method

seller_idstring required

The ID of the seller to add the shipping method for

seller_shipping_method_referencestring required

Seller's own reference for this shipping method

Example request

{
  "is_in_store_pickup": false,
  "name": "United Parcel Service",
  "seller_id": "gravis",
  "seller_shipping_method_reference": "Sandbox Shipping Service"
}

Response

Created response.

idstring regexp required

shipping method ID

is_in_store_pickupboolean
namestring required

Shipping method name

review_status'supported' | 'unsupported' | 'to_be_reviewed' required
seller_idstring regexp

seller ID

seller_shipping_method_referencestring required

Seller's own reference for this shipping method

Example response

{
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "is_in_store_pickup": false,
  "name": "abc123",
  "review_status": "to_be_reviewed",
  "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_shipping_method_reference": "Sandbox Shipping Service"
}