Shipping Methods

The endpoint lists all available shipping methods that can be transferred in the endpoint orders.

#List

Returns a collection of shipping methods.

#Filtering

You can filter your results as follows:

#List shipping methods for specified id(s)

• /shipping-methods?filter[id]=1
• /shipping-methods?filter[id]=1,2,3

#List shipping methods for specified name(s)

• /shipping-methods?filter[name]=UPS Standard
• /shipping-methods?filter[name]=UPS Standard,Pickup

#List shipping methods for specified handle(s)

• /shipping-methods?filter[handle]=ups-standard
• /shipping-methods?filter[handle]=ups-standard,pickup

#Example

GET /shipping-methods HTTP/1.1

{
    "data": [
        {
            "id": 1,
            "name": "UPS Standard",
            "handle": "ups-standard",
            "available_in": [
				{
					"code": "DE"
				},
				{
					"code": "FR"
				},
				{
					"code": "ES"
				}
			],
            "created_at": "2022-02-01T08:35:45+00:00",
			"updated_at": "2022-02-01T08:35:45+00:00"
        },
        {
            "id": 2,
            "name": "Pickup",
            "handle": "pickup",
            "available_in": [
				{
					"code": "DE"
				},
				{
					"code": "FR"
				},
				{
					"code": "ES"
				}
			],
            "created_at": "2022-02-01T08:35:45+00:00",
			"updated_at": "2022-02-01T08:35:45+00:00"
        }
        ...
    ],
    "links": {
        "first": "https://api.smake.io/v2/shipping-methods?page=1",
        "last": null,
        "prev": null,
        "next": "https://api.smake.io/v2/shipping-methods?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.smake.io/v2/shipping-methods",
        "per_page": 25,
        "to": 25
    }
}