Skip to content

Latest commit

 

History

History
206 lines (135 loc) · 10.2 KB

FulfillmentCancellationsApi.md

File metadata and controls

206 lines (135 loc) · 10.2 KB
Raw

DigitalRiver\ApiSdk\FulfillmentCancellationsApi

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

Method HTTP request Description
createFulfillmentCancellations POST /fulfillment-cancellations Creates a cancellation
listFulfillmentCancellations GET /fulfillment-cancellations Returns a list of fulfillment cancellations
retrieveFulfillmentCancellations GET /fulfillment-cancellations/{id} Gets a fulfillment cancellation by its unique identifier.

createFulfillmentCancellations

\DigitalRiver\ApiSdk\Model\GlobalFulfillmentCancellationResponse createFulfillmentCancellations($global_fulfillment_cancellation_request)

Creates a cancellation

Cancels all or part of a previously created fulfillment order.

Example

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


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

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

Parameters

Name Type Description Notes
global_fulfillment_cancellation_request \DigitalRiver\ApiSdk\Model\GlobalFulfillmentCancellationRequest [optional]

Return type

\DigitalRiver\ApiSdk\Model\GlobalFulfillmentCancellationResponse

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]

listFulfillmentCancellations

\DigitalRiver\ApiSdk\Model\ListGlobalFulfillmentCancellationsResponse listFulfillmentCancellations($created_time, $ending_before, $starting_after, $limit, $ids, $upstream_ids, $state, $fulfillment_order_id, $inventory_item_id)

Returns a list of fulfillment cancellations

Get all fulfillment cancellations.

Example

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


$apiInstance = new DigitalRiver\ApiSdk\Api\FulfillmentCancellationsApi(
    // 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.
$upstream_ids = array('upstream_ids_example'); // string[] | Only return objects with these upstreamIds.
// Refer string[]::$setters in digital-river-php/lib/Model/string.php to set the properties.
$state = 'state_example'; // string | Only return objects in the given state

$fulfillment_order_id = 'fulfillment_order_id_example'; // string | The fulfillment order to retrieve cancellations for.

$inventory_item_id = 'inventory_item_id_example'; // string | The inventory item id to retrieve cancellations for.


try {
    $result = $apiInstance->listFulfillmentCancellations($created_time, $ending_before, $starting_after, $limit, $ids, $upstream_ids, $state, $fulfillment_order_id, $inventory_item_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FulfillmentCancellationsApi->listFulfillmentCancellations: ', $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]
upstream_ids string[] Only return objects with these upstreamIds. [optional]
state string Only return objects in the given state [optional]
fulfillment_order_id string The fulfillment order to retrieve cancellations for. [optional]
inventory_item_id string The inventory item id to retrieve cancellations for. [optional]

Return type

\DigitalRiver\ApiSdk\Model\ListGlobalFulfillmentCancellationsResponse

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]

retrieveFulfillmentCancellations

\DigitalRiver\ApiSdk\Model\GlobalFulfillmentCancellationResponse retrieveFulfillmentCancellations($id)

Gets a fulfillment cancellation by its unique identifier.

Retrieves the details of a fulfillment cancellation. Supply the unique identifier of the cancellation.

Example

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


$apiInstance = new DigitalRiver\ApiSdk\Api\FulfillmentCancellationsApi(
    // 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 | Cancellation ID


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

Parameters

Name Type Description Notes
id string Cancellation ID

Return type

\DigitalRiver\ApiSdk\Model\GlobalFulfillmentCancellationResponse

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]