Shipping Methods¶

URLs¶

• http://example.com/api/shippings—refer to all shipping methods. Only GET and POST are supported.

• http://example.com/api/shippings/:id—refer to a particular shipping method. GET, PUT, and DELETE are supported.

Pagination¶

To get a specific number of shipping methods or list of shipping methods from a concrete page in a response, use pagination parameters:

Examples:

• http://example.com/api/shippings?page=5

Response is an array with 10 shipping methods from the 5th page (10 is the default value of the items_per_page parameter).

• http://example.com/api/shippings?items_per_page=20

Response is an array with 20 shipping methods from the first page.

• http://example.com/api/shippings?page=5&items_per_page=20

Response is an array with 20 shipping methods from the 5th page.

Fields¶

A shipping method has a number of properties, represented by fields.

The full list of supported fields is given below (mandatory fields are marked with *).