Search shipping methods
Last updated: 25-Sep-2019
Rate this article:
Overview
Use searchShippingMethods to retrieve information on the shipping methods currently defined on your account.
Search filters
Use the parameters below to filter the results of your search for shipping methods.
| Parameter | Type/Description | |
|---|---|---|
| Name |
String / Optional Name of the shipping method. |
|
| Codes |
Array of strings / Optional Codes assigned to the shipping methods. |
|
| Countries |
Array of strings / Optional Countries to which the shipping method is assigned. |
|
| Active |
Boolean / Optional TRUE - active shipping methods FALSE - inactive shipping methods |
|
| Pagination |
Object / Optional Control the results pagination. |
|
| Page |
Integer / Optional Number of pages to display the results |
|
| Limit |
Integer / Optional Limit the number of results of the search |
|
Sample request
<?php
require ('PATH_TO_AUTH'); // authentication call
$SearchOptions = new \stdClass();
$SearchOptions->Name = 'ShippingMethodName'; // search for a specific shipping method
$SearchOptions->Codes = ['Code1', 'Code2', 'Code3']; // array of shipping method codes
$SearchOptions->Countries = ['US', 'UK', 'AU']; // array of country codes
$SearchOptions->Active = true; // only active shipping methods
$SearchOptions->Pagination = new \stdClass();
$SearchOptions->Pagination->Page = 1; // set display pages
$SearchOptions->Pagination->Limit = 200; // limit the results
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'searchShippingMethods',
'params' => array($sessionID, $SearchOptions)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
Response
| Parameter | Type/Description |
|---|---|
| ShippingMethod |
Object |
Rate this article:
