TOtopi
ops
ops-shipping-methods

Create a shipping method

Changed on

Create a new shipping method for a seller

post/ops/shipping-method

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/shipping-method
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-shipping-method:edit

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"
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id shipping-method-ops.create removed and replaced with shipping-method-ops#create

  • 7ff7ee94b30eRevision changes
    • info

      api operation id shipping-method-ops#create removed and replaced with shipping-method-ops.create

    • info

      api tag ops-shipping-methods added