> For the complete documentation index, see [llms.txt](https://docs.2checkout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-responses/shipping-method.md).

# Shipping method

The object below is returned directly or within a successful response from the following API requests:

<a href="https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-requests/shipping-in-api/search-shipping-methods.md" class="button primary" data-icon="magnifying-glass">Search shipping method</a>

## Shipping method object

<table><thead><tr><th width="383.5999755859375">Parameter</th><th>Type / Description</th></tr></thead><tbody><tr><td><code>Items</code></td><td><strong>Array of objects</strong><br>Contains shipping methods objects.</td></tr><tr><td><code>Items.ShippingMethod</code></td><td><p><strong>Shipping method object.</strong></p><p>Details below.</p></td></tr><tr><td><code>Items.ShippingMethod.Name</code></td><td><strong>String</strong><br>Shipping method name that you define when creating the method.</td></tr><tr><td><code>Items.ShippingMethod.Code</code></td><td><strong>String</strong><br>System-generated identified for the shipping method.</td></tr><tr><td><code>Items.ShippingMethod.TrackingURL</code></td><td><strong>String</strong><br>URL assigned to the shipping method. Provided to your customers that purchase physical products.</td></tr><tr><td><code>Items.ShippingMethod.BasePrice</code></td><td><strong>String</strong><br>Base fee attached to the shipping method, that will be charged to customers when shipping method is available in cart, regardless of their country, product value or weight.</td></tr><tr><td><code>Items.ShippingMethod.Currency</code></td><td><strong>String</strong><br>Currency in which the base fee is expressed. Example: 'USD'.</td></tr><tr><td><code>Items.ShippingMethod.Active</code></td><td><p><strong>Boolean</strong></p><p>Possible values:</p><ul><li><strong>TRUE</strong> - if shipping method is active.</li><li><strong>FALSE</strong> - if shipping method is inactive.</li></ul></td></tr><tr><td><code>Items.ShippingMethod.Availability</code></td><td><p><strong>Strings</strong></p><p>Defined where the shipping method is active.</p><p>Possible values:</p><ul><li><strong>ALL</strong> - all delivery countries.</li><li><strong>CUSTOM</strong> - selected delivery countries.</li><li><strong>HOME</strong> - only your home country.</li></ul></td></tr><tr><td><code>Items.ShippingMethod.Countries</code></td><td><strong>Array of objects</strong><br>Countries where the shipping method applies.</td></tr><tr><td><code>Items.ShippingMethod.Countries.CountryCode</code></td><td><strong>String</strong><br>Two-letters country code.</td></tr><tr><td><code>Items.ShippingMethod.Countries.Surcharge</code></td><td><strong>String</strong><br>Surcharge defined for each country.</td></tr><tr><td><code>Items.ShippingMethod.Surcharge</code></td><td><strong>Array of objects</strong><br>Additional fee assigned to the shipping method.</td></tr><tr><td><code>Items.ShippingMethod.Surcharge.Type</code></td><td><p><strong>String</strong></p><p>Order property based on which the surcharge is added.</p><p>Possible values:</p><ul><li><strong>PRICE</strong> -  surcharge is based on total order amount.</li><li><strong>WEIGHT</strong> -  surcharged is based on total order weight.</li></ul></td></tr><tr><td><code>Items.ShippingMethod.Surcharge.From</code></td><td><strong>Float</strong><br>Lower interval limit.</td></tr><tr><td><code>Items.ShippingMethod.Surcharge.To</code></td><td><strong>Int</strong><br>Higher interval limit.</td></tr><tr><td><code>Items.ShippingMethod.Surcharge.Amount</code></td><td><strong>Int</strong><br>Surcharge defined based on order price / weight.</td></tr><tr><td><code>Items.ShippingMethod.Surcharge.ApplyTo</code></td><td><p><strong>String</strong></p><p>Possible values:</p><ul><li>interval - surcharge is added for a given interval. Example: from 1 kg to 4kg.</li><li>unit - surcharge is added for each additional unit. Example: $5 for each unit over 4 kg.</li></ul></td></tr><tr><td><code>Items.Pagination</code></td><td><strong>Object</strong><br>Pagination filters.</td></tr><tr><td><code>Items.Pagination.Page</code></td><td><strong>Int</strong><br>Number of pages used for displaying the results.</td></tr><tr><td><code>Items.Pagination.Limit</code></td><td><strong>Int</strong><br>Number for limiting the results.</td></tr><tr><td><code>Items.Pagination.Count</code></td><td><strong>Int</strong><br>Total number of results.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-responses/shipping-method.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
