All URIs are relative to https://api.digitalriver.com
| Method | HTTP request | Description |
|---|---|---|
| listShipments | GET /shipments | Returns a list of shipments |
| retrieveShipments | GET /shipments/{id} | Gets a shipment by ID. |
\DigitalRiver\ApiSdk\Model\InlineResponse2004 listShipments($created_time, $updated_time, $ending_before, $starting_after, $limit, $ids)
Returns a list of shipments
Get all shipments
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DigitalRiver\ApiSdk\Api\ShipmentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$created_time = createdTime[gt]=2020-09-22T12:09:44Z; // map[string,\DateTime] | A filter on the list based on the **createdTime** field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - **eq**—return values where the createdTime field equals to this timestamp - **gt**—return values where the createdTime field is after this timestamp - **gte**—return values where the createdTime field is after or equal to this timestamp - **lt**—return values where the createdTime field is before this timestamp - **lte**—return values where the createdTime field is before or equal to this timestamp
// Refer map[string,\DateTime]::$setters in digital-river-php/lib/Model/\DateTime.php to set the properties.
$updated_time = updatedTime[gt]=2020-09-22T12:09:44Z; // map[string,\DateTime] | A filter on the list based on the **updatedTime** field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - **eq**—return values where the updatedTime field equals this timestamp - **gt**—return values where the updatedTime field is after this timestamp - **gte**—return values where the updatedTime field is after or equal to this timestamp - **lt**—return values where the updatedTime field is before this timestamp - **lte**—return values where the updatedTime field is before or equal to this timestamp
// Refer map[string,\DateTime]::$setters in digital-river-php/lib/Model/\DateTime.php to set the properties.
$ending_before = 'ending_before_example'; // string | A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
$starting_after = 'starting_after_example'; // string | A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
$limit = 56; // int | A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
$ids = array('ids_example'); // string[] | Only return objects with these IDs.
// Refer string[]::$setters in digital-river-php/lib/Model/string.php to set the properties.
try {
$result = $apiInstance->listShipments($created_time, $updated_time, $ending_before, $starting_after, $limit, $ids);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->listShipments: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| created_time | map[string,\DateTime] | A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - eq—return values where the createdTime field equals to this timestamp - gt—return values where the createdTime field is after this timestamp - gte—return values where the createdTime field is after or equal to this timestamp - lt—return values where the createdTime field is before this timestamp - lte—return values where the createdTime field is before or equal to this timestamp | [optional] |
| updated_time | map[string,\DateTime] | A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - eq—return values where the updatedTime field equals this timestamp - gt—return values where the updatedTime field is after this timestamp - gte—return values where the updatedTime field is after or equal to this timestamp - lt—return values where the updatedTime field is before this timestamp - lte—return values where the updatedTime field is before or equal to this timestamp | [optional] |
| ending_before | string | A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list. | [optional] |
| starting_after | string | A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list. | [optional] |
| limit | int | A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10. | [optional] |
| ids | string[] | Only return objects with these IDs. | [optional] |
\DigitalRiver\ApiSdk\Model\InlineResponse2004
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DigitalRiver\ApiSdk\Model\Shipment retrieveShipments($id)
Gets a shipment by ID.
Retrieves the details of a shipment. You must supply the unique identifier of the shipment.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new DigitalRiver\ApiSdk\Api\ShipmentsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 'id_example'; // string | Shipment identifier.
try {
$result = $apiInstance->retrieveShipments($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->retrieveShipments: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Shipment identifier. |
\DigitalRiver\ApiSdk\Model\Shipment
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]