v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Delivery checkout

Get Shopify shipping method

The endpoint will return details for a specific Shopify shipping method that belongs to your account.

get/shipping_modules/shopify/shipping_methods/{id}

Path parameters

idinteger required
Example:12345

The ID of the Shopify shipping method.

Response

Successful.

idinteger

The ID of the Shopify shipping method.

product_typestring

The product type name of the shipping method. E.g. SERVICE_POINT, BUSINESS or PRIVATE

shipping_agent_codestring

The code of the shipping agent/carrier.

shipping_product_global_codestring

The global product code for the shipping method.

service_point_typesstring[]

Array of service point type codes associated with this shipping method. If empty, all service point types are included.

Example response

{
  "id": 12345,
  "product_type": "SERVICE_POINT",
  "shipping_agent_code": "gls",
  "shipping_product_global_code": "GLSDK_SD",
  "service_point_types": [
    "SP",
    "BOX"
  ]
}