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
ShopTranslation
Overview
Represents the translation data for a Shop.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
shop_id |
public |
none | int |
The numeric ID for the Shop. |
language |
public |
none | language |
The IETF language tag (e.g. 'fr') for the language of this translation. |
announcement |
public |
none | string |
Translation of an announcement to buyers that displays on the shop's homepage. |
policy_welcome |
public |
none | string |
Translation of the introductory text from the top of the seller's policies page (may be blank). |
policy_payment |
public |
none | string |
Translation of the seller's policy on payment (may be blank). |
policy_shipping |
public |
none | string |
Translation of the seller's policy on shipping (may be blank). |
policy_refunds |
public |
none | string |
Translation of the seller's policy on refunds (may be blank). |
policy_additional |
public |
none | string |
Translation of any additional policy information the seller provides (may be blank). |
policy_privacy |
public |
none | string |
Translation of privacy policy information the seller provides (may be blank). |
policy_seller_info |
public |
none | string |
Translation of the Shop's Seller information (may be blank). |
sale_message |
public |
none | string |
Translation of a message that is sent to users who buy from this shop. |
digital_sale_message |
public |
none | string |
Translation of a message that is sent to users who buy a digital item from this shop. |
title |
public |
none | string |
Translation of a brief heading for the shop's main page. |
vacation_autoreply |
public |
none | string |
Translation of a message to buyers in response to new convos (if Shop.is_vacation is true). |
vacation_message |
public |
none | string |
Translation of a message to buyers (if Shop.is_vacation is true). |
Associations
This resource has no associations.
Methods
getShopTranslation
Method Name | getShopTranslation |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a ShopTranslation by shop_id and language | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /shops/:shop_id/translations/:language |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | N |
||||||||||||
Permission Scope | none |
createShopTranslation
Method Name | createShopTranslation |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Creates a ShopTranslation by shop_id and language | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | POST |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URI | /shops/:shop_id/translations/:language |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|
updateShopTranslation
Method Name | updateShopTranslation |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Updates a ShopTranslation by shop_id and language | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URI | /shops/:shop_id/translations/:language |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|
deleteShopTranslation
Method Name | deleteShopTranslation |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Deletes a ShopTranslation by shop_id and language | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /shops/:shop_id/translations/:language |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|