logistics APIv1_beta.0.0

cancelShipment

POST
/shipment/{shipmentId}/cancel
This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the totalShippingCost of the canceled shipment is refunded to the account established by the user's billing agreement.

Note that you cannot cancel a shipment if you have used the associated shipping label.

Input

Resource URI (production)

POST https://api.ebay.com/sell/logistics/v1_beta/shipment/{shipmentId}/cancel

URI parameters

ParameterTypeDescription
shipmentIdstringThis path parameter specifies the unique eBay-assigned ID of the shipment to be canceled. The shipmentId value is generated and returned by a call to createFromShippingQuote.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope/sell.logistics

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* Shipment */
"orders" : [
{ /* Order */ }
],
}
Output container/fieldTypeDescription
cancellationShipmentCancellationCancellation status for the package, if one exists.

Occurrence: Conditional

cancellation.cancellationRequestedDatestringThe time and date the request was made to cancel the shipment, formatted as an ISO 8601 UTC string.

Occurrence: Conditional

cancellation.cancellationStatusShipmentCancellationStatusEnumThis enum specifies the current cancellation status of a shipment, if a cancellation request has been made.

Occurrence: Conditional

creationDatestringThe date and time the shipment was created, formatted as an ISO 8601 UTC string.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2018-08-06T01:00:00.000Z

Occurrence: Conditional

labelCustomMessagestringIf supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label.

Occurrence: Conditional

labelDownloadUrlstringThe direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See downloadLabelFile for requesting different response file formats.

Occurrence: Conditional

labelSizestringThe seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the creaateFromShippingQuote call matches a size the carrier supports, the value will be represented here in the shipment.

Currently, the only valid value is: 4"x6"

Occurrence: Conditional

ordersarray of OrderThis list value is optionally assigned by the seller. When present, each element in the returned list contains seller-assigned information about an order (such as an order number). Because a package can contain all or part of one or more orders, this field provides a way for sellers to identify the packages that contain specific orders.

Occurrence: Conditional

orders.channelstringThe e-commerce platform or environment where the order was created. Use the value EBAY to get the rates available for eBay orders.

Occurrence: Conditional

orders.orderIdstringThe unique ID of the order supplied by the channel of origin. For eBay orders, this would be the orderId.

Occurrence: Conditional

packageSpecificationPackageSpecificationThe weight and dimensions of the package.

Occurrence: Conditional

packageSpecification.dimensionsDimensionsDeclares the height, length, width, and unit of measure for the package to be shipped.

Occurrence: Conditional

packageSpecification.dimensions.heightstringThe numeric value of the height of the package.

Occurrence: Conditional

packageSpecification.dimensions.lengthstringThe numeric value of the length of the package.

Occurrence: Conditional

packageSpecification.dimensions.unitLengthUnitOfMeasureEnumThe unit of measure used to express the height, length, and width of the package.

Occurrence: Conditional

packageSpecification.dimensions.widthstringThe numeric value of the width of the package.

Occurrence: Conditional

packageSpecification.weightWeightDeclares the weight of the package.

Occurrence: Conditional

packageSpecification.weight.unitWeightUnitOfMeasureEnumThe unit of measure used to express the weight of the package.

Occurrence: Conditional

packageSpecification.weight.valuestringThe numeric value of the weight of the package, as measured by the value of unit.

Occurrence: Conditional

ratePurchasedRateThe shipping rate that the seller has chosen to purchase for this shipment. Each rate, identified by a rateId, contains the offered base service, options, and shipping parameters that were selected for the package shipment.

Occurrence: Conditional

rate.additionalOptionsarray of AdditionalOptionAn list of additional, optional features that have been purchased for the shipment.

Occurrence: Conditional

rate.additionalOptions.additionalCostAmountThe monetary cost of the additional shipping option identified by the optionType field.

Occurrence: Conditional

rate.additionalOptions.additionalCost.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Conditional

rate.additionalOptions.additionalCost.valuestringThe value of the monetary amount in the specified currency.

Occurrence: Conditional

rate.additionalOptions.optionTypestringThe name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected rate.

Occurrence: Conditional

rate.baseShippingCostAmountThe amount of the "base cost" for the shipment as set by the given carrier for the specified service. This cost excludes any addition costs accrued from the addition of any optional shipping options.

Occurrence: Conditional

rate.baseShippingCost.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Conditional

rate.baseShippingCost.valuestringThe value of the monetary amount in the specified currency.

Occurrence: Conditional

rate.destinationTimeZonestringThe time zone of the destination according to Time Zone Database. For example, "America/Los_Angeles".

Occurrence: Conditional

rate.maxEstimatedDeliveryDatestringA string value representing maximum (latest) estimated delivery time, formatted as an ISO 8601 UTC string.

Occurrence: Conditional

rate.minEstimatedDeliveryDatestringA string value representing minimum (earliest) estimated delivery time, formatted as an ISO 8601 UTC string.

Occurrence: Conditional

rate.pickupNetworksarray of stringA list of pickup networks compatible with the shipping service.

Occurrence: Conditional

rate.pickupSlotIdstringThis unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup.

Occurrence: Conditional

rate.pickupTypePickupTypeEnumThe type of pickup or drop off configured for the shipment.

Occurrence: Conditional

rate.rateIdstringThe eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment.

Occurrence: Conditional

rate.shippingCarrierCodestringThe ID code for the carrier that was selected for the package shipment.

Occurrence: Conditional

rate.shippingCarrierNamestringThe name of the shipping carrier.

Occurrence: Conditional

rate.shippingQuoteIdstringThe unique eBay-generated ID of the shipping quote from which the seller selected a shipping rate (rateId).

Occurrence: Conditional

rate.shippingServiceCodestringString ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies.

Occurrence: Conditional

rate.shippingServiceNamestringThe name of the shipping service.

Occurrence: Conditional

rate.totalShippingCostAmountThe total shipping cost, which is the sum cost of the base shipping cost and the cost of all the selected shipping options.

Occurrence: Conditional

rate.totalShippingCost.currencyCurrencyCodeEnumThe base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Conditional

rate.totalShippingCost.valuestringThe value of the monetary amount in the specified currency.

Occurrence: Conditional

returnToContactThe address and contact details that should be used for item returns. Sellers have the option to define a return address that is different from their shipFrom address. If not specified, the return address defaults to the shipFrom address in the shipping quote.

Occurrence: Conditional

returnTo.companyNamestringThe company name with which the contact is associated.

Occurrence: Conditional

returnTo.contactAddressContactAddressThe details of the contact's geographical address.

Occurrence: Conditional

returnTo.contactAddress.addressLine1stringThe first line of the street address.

Occurrence: Always

returnTo.contactAddress.addressLine2stringThe second line of the street address. Use this field for additional address information, such as a suite or apartment number.

Occurrence: Conditional

returnTo.contactAddress.citystringThe city in which the address is located.

Occurrence: Conditional

returnTo.contactAddress.countryCodeCountryCodeEnumThe country of the address, represented as two-letter ISO 3166-1 Alpha-2 country code. For example, US represents the United States and DE represents Germany.

Occurrence: Conditional

returnTo.contactAddress.countystringThe county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

returnTo.contactAddress.postalCodestringThe postal code of the address.

Occurrence: Always

returnTo.contactAddress.stateOrProvincestringThe state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

returnTo.fullNamestringThe contact's full name.

Occurrence: Conditional

returnTo.primaryPhonePhoneNumberThe contact's primary telephone number.

Occurrence: Conditional

returnTo.primaryPhone.phoneNumberstringA telephone number.

Occurrence: Conditional

shipFromContactThe address and contact details for the origin of the package shipment.

Occurrence: Conditional

shipFrom.companyNamestringThe company name with which the contact is associated.

Occurrence: Conditional

shipFrom.contactAddressContactAddressThe details of the contact's geographical address.

Occurrence: Conditional

shipFrom.contactAddress.addressLine1stringThe first line of the street address.

Occurrence: Always

shipFrom.contactAddress.addressLine2stringThe second line of the street address. Use this field for additional address information, such as a suite or apartment number.

Occurrence: Conditional

shipFrom.contactAddress.citystringThe city in which the address is located.

Occurrence: Conditional

shipFrom.contactAddress.countryCodeCountryCodeEnumThe country of the address, represented as two-letter ISO 3166-1 Alpha-2 country code. For example, US represents the United States and DE represents Germany.

Occurrence: Conditional

shipFrom.contactAddress.countystringThe county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

shipFrom.contactAddress.postalCodestringThe postal code of the address.

Occurrence: Always

shipFrom.contactAddress.stateOrProvincestringThe state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

shipFrom.fullNamestringThe contact's full name.

Occurrence: Conditional

shipFrom.primaryPhonePhoneNumberThe contact's primary telephone number.

Occurrence: Conditional

shipFrom.primaryPhone.phoneNumberstringA telephone number.

Occurrence: Conditional

shipmentIdstringThe unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to createFromShippingQuote.

Occurrence: Conditional

shipmentTrackingNumberstringA unique carrier-assigned ID string that can be used to track the shipment.

Occurrence: Conditional

shipToContactThe address and contact details for the destination of the shipment.

Occurrence: Conditional

shipTo.companyNamestringThe company name with which the contact is associated.

Occurrence: Conditional

shipTo.contactAddressContactAddressThe details of the contact's geographical address.

Occurrence: Conditional

shipTo.contactAddress.addressLine1stringThe first line of the street address.

Occurrence: Always

shipTo.contactAddress.addressLine2stringThe second line of the street address. Use this field for additional address information, such as a suite or apartment number.

Occurrence: Conditional

shipTo.contactAddress.citystringThe city in which the address is located.

Occurrence: Conditional

shipTo.contactAddress.countryCodeCountryCodeEnumThe country of the address, represented as two-letter ISO 3166-1 Alpha-2 country code. For example, US represents the United States and DE represents Germany.

Occurrence: Conditional

shipTo.contactAddress.countystringThe county (not country) in which the address is located. Counties typically contain multiple cities or towns.

Occurrence: Conditional

shipTo.contactAddress.postalCodestringThe postal code of the address.

Occurrence: Always

shipTo.contactAddress.stateOrProvincestringThe state or province in which the address is located. States and provinces often contain multiple counties.

Occurrence: Conditional

shipTo.fullNamestringThe contact's full name.

Occurrence: Conditional

shipTo.primaryPhonePhoneNumberThe contact's primary telephone number.

Occurrence: Conditional

shipTo.primaryPhone.phoneNumberstringA telephone number.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
404Not Found
409Conflict
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
90000API_LOGISTICSAPPLICATIONA system error has occurred.
90005API_LOGISTICSREQUESTThe resource could not be found.
90260API_LOGISTICSREQUESTCannot cancel shipment {shipmentId}

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Cancel a shipment

This method cancels an existing shipment and refunds the totalShippingCost to the account that was billed when the shipment was created.

Input

This method does not use a request body. Supply the shipmentId as a path parameter in your request.
POST
https://api.ebay.com/sell/logistics/v1_beta/shipment/SHIPMENT-001/cancel

Output

If the call is successful, an HTTP status code 200 OK is returned. The response body contains the fill details of the of the shipment that was canceled and the cancellationStatus is set to CANCELLATION_REQUESTED.