Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
ShippingUpgrade
Overview
Represents shipping upgrade info.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
shipping_profile_id |
public |
none | int |
Identifier for the parent shipping profile |
value_id |
public |
none | int |
Identifier for the value |
value |
public |
none | string |
Name of the shipping upgrade, e.g. USPS Priority |
price |
public |
none | float |
Additional cost of adding the shipping upgrade |
secondary_price |
public |
none | float |
Additional cost of adding the shipping upgrade with another item |
currency_code |
public |
none | string |
Currency for the price |
type |
public |
none | int |
Domestic (0) or international (1) |
order |
public |
none | int |
Display order |
language |
public |
none | int |
Language code |
min_delivery_time |
public |
none | int |
The minimum delivery time that a shipment will take, in days. |
max_delivery_time |
public |
none | int |
The maximum delivery time that a shipment will take, in days. |
shipping_carrier_id |
public |
none | int |
The numeric ID of the shipping carrier. |
mail_class |
public |
none | string |
The string representation of a shipping carrier's mail class. |
Associations
This resource has no associations.
Methods
getListingShippingUpgrades
Method Name | getListingShippingUpgrades |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Get the shipping upgrades available for a listing. | ||||||||
HTTP Method | GET |
||||||||
URI | /listings/:listing_id/shipping/upgrades |
||||||||
Parameters |
|
||||||||
Requires OAuth | Y |
||||||||
Permission Scope |
|
createListingShippingUpgrade
Method Name | createListingShippingUpgrade |
||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Creates a new ShippingUpgrade for the listing. Will unlink the listing if linked to a ShippingTemplate. | ||||||||||||||||||||||||||||||||||||||||
HTTP Method | POST |
||||||||||||||||||||||||||||||||||||||||
URI | /listings/:listing_id/shipping/upgrades |
||||||||||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|
updateListingShippingUpgrade
Method Name | updateListingShippingUpgrade |
||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Updates a ShippingUpgrade on a listing. Will unlink the listing if linked to a ShippingTemplate. | ||||||||||||||||||||||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||||||||||||||||||||||
URI | /listings/:listing_id/shipping/upgrades |
||||||||||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|
deleteListingShippingUpgrade
Method Name | deleteListingShippingUpgrade |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Deletes the ShippingUpgrade from the listing. Will unlink the listing if linked to a ShippingTemplate. | ||||||||||||||||
HTTP Method | DELETE |
||||||||||||||||
URI | /listings/:listing_id/shipping/upgrades |
||||||||||||||||
Parameters |
|
||||||||||||||||
Requires OAuth | Y |
||||||||||||||||
Permission Scope |
|