Shipments

List shipping methods

Lists the store's configured shipping methods. This does not check availability for a destination. Each method includes its configured destination countries and active checkout shipping-option IDs (so_…), which are also accepted as shipping_method_id when creating a shipment. See Shopify orders for Shopify delivery codes.

get/api/external/v1/shipping-methods

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/shipping-methods
  • Auth: HTTP bearer

Response

Example response

{
  "data": [
    {
      "id": "sm_a1b2c3",
      "name": "PostNord Service Point",
      "description": "Delivery to a nearby pickup point.",
      "delivery_type": "pickup_point",
      "requires_service_point": true,
      "countries": [
        "DK",
        "SE"
      ],
      "carrier": {
        "id": "postnord",
        "name": "PostNord",
        "account_number": "1234567"
      },
      "status": "active",
      "mode": "production",
      "shipping_options": [
        "so_d4e5f6",
        "so_g7h8i9"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.