search
System Status

Fulfillment cancellations

The Fulfillment Cancellations resource enables businesses to streamline inventory management by providing a reliable method to cancel the delivery of inventory items when coordinated through Digital River's fulfillment services. This API is essential for managing changes in order details or customer requests, ensuring efficient handling of cancellations, and maintaining customer satisfaction. By leveraging this resource, businesses can maintain accurate inventory levels and minimize logistical overhead.

hashtag
Returns a list of fulfillment cancellations

get

Get all fulfillment cancellations.

Query parameters
endingBeforestringOptional

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.

startingAfterstringOptional

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.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

upstreamIdsstring[]Optional

Only return objects with these upstreamIds.

statestringOptional

Only return objects in the given state

fulfillmentOrderIdstringOptional

The fulfillment order to retrieve cancellations for.

inventoryItemIdstringOptional

The inventory item id to retrieve cancellations for.

Responses
chevron-right
200

200 OK

application/json
hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true
get
/fulfillment-cancellations

hashtag
Creates a cancellation

post

Cancels all or part of a previously created fulfillment order.

Body
fulfillmentOrderIdstringRequired

The unique identifier of the fulfillment order associated with the fulfillment cancellation.

Example: 6645940010
upstreamIdstringOptional

The unique identifier of the upstream order.

Example: 6645940010
reasonstringOptional

The reason for the cancellation.

Example: requested_by_customer
Responses
post
/fulfillment-cancellations

hashtag
Gets a fulfillment cancellation by its unique identifier

get

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

Path parameters
idstringRequired

Cancellation ID

Responses
chevron-right
200

OK.

application/json
idstringRead-onlyOptional

The unique identifier of the fulfillment cancellation

Example: ret_5823594809
createdTimestring · date-timeRead-onlyOptional

The time at which the fulfillment cancellation was created.

Example: 2018-04-25T20:36:00Z
fulfillmentOrderIdstringRead-onlyOptional

The unique identifier of the fulfillment order associated with the fulfillment cancellation.

Example: ord_6645940010
upstreamIdstringRead-onlyOptional

The unique identifier of the upstream order.

Example: ord_6645940010
reasonstringOptional

The reason for the cancellation.

Example: requested_by_customer
statestring · enumOptional

An enumeration indicating the state of the fulfillment cancellation.

Example: pendingPossible values:
livemodebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false
get
/fulfillment-cancellations/{id}
PreviousFulfillmentsNextFulfillment orders

Last updated