Skip to content

Latest commit

 

History

History
197 lines (128 loc) · 8.52 KB

ShippingLabelsApi.md

File metadata and controls

197 lines (128 loc) · 8.52 KB
Raw

DigitalRiver\ApiSdk\ShippingLabelsApi

All URIs are relative to https://api.digitalriver.com

Method HTTP request Description
createShippingLabel POST /shipping-labels Returns shipping label
listShippingLabel GET /shipping-labels Returns shipping label
retrieveShippingLabels GET /shipping-labels/{id} Gets a shipping label by ID.

createShippingLabel

\DigitalRiver\ApiSdk\Model\ShippingLabelResponse createShippingLabel($shipping_label_request)

Returns shipping label

Create a shipping label

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new DigitalRiver\ApiSdk\Api\ShippingLabelsApi(
    // 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()
);
$shipping_label_request = new \DigitalRiver\ApiSdk\Model\ShippingLabelRequest(); // \DigitalRiver\ApiSdk\Model\ShippingLabelRequest | 
// Refer \DigitalRiver\ApiSdk\Model\ShippingLabelRequest::$setters in digital-river-php/lib/Model/ShippingLabelRequest.php to set the properties.

try {
    $result = $apiInstance->createShippingLabel($shipping_label_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShippingLabelsApi->createShippingLabel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
shipping_label_request \DigitalRiver\ApiSdk\Model\ShippingLabelRequest [optional]

Return type

\DigitalRiver\ApiSdk\Model\ShippingLabelResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listShippingLabel

\DigitalRiver\ApiSdk\Model\ListShippingLabel listShippingLabel($created_time, $ending_before, $starting_after, $limit, $ids, $order_id)

Returns shipping label

List shipping labels

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new DigitalRiver\ApiSdk\Api\ShippingLabelsApi(
    // 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**&mdash;return values where the createdTime field equals to this timestamp   - **gt**&mdash;return values where the createdTime field is after this timestamp   - **gte**&mdash;return values where the createdTime field is after or equal to this timestamp   - **lt**&mdash;return values where the createdTime field is before this timestamp   - **lte**&mdash;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.
$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.
$order_id = 'order_id_example'; // string | The order to retrieve returns for.


try {
    $result = $apiInstance->listShippingLabel($created_time, $ending_before, $starting_after, $limit, $ids, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShippingLabelsApi->listShippingLabel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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&mdash;return values where the createdTime field equals to this timestamp - gt&mdash;return values where the createdTime field is after this timestamp - gte&mdash;return values where the createdTime field is after or equal to this timestamp - lt&mdash;return values where the createdTime field is before this timestamp - lte&mdash;return values where the createdTime 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]
order_id string The order to retrieve returns for. [optional]

Return type

\DigitalRiver\ApiSdk\Model\ListShippingLabel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieveShippingLabels

\DigitalRiver\ApiSdk\Model\ShippingLabelResponse retrieveShippingLabels($id)

Gets a shipping label by ID.

Retrieves the details of a shipping label. Supply the unique identifier of the shipping label.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new DigitalRiver\ApiSdk\Api\ShippingLabelsApi(
    // 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 | Shipping Label ID


try {
    $result = $apiInstance->retrieveShippingLabels($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShippingLabelsApi->retrieveShippingLabels: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string Shipping Label ID

Return type

\DigitalRiver\ApiSdk\Model\ShippingLabelResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]