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.

API Documentation

ShopSectionTranslation

Overview

Represents the translation data for a ShopSection.

Fields

Field Visibility Level Permission Scope Type Description
shop_section_id public none int The numeric ID for the ShopSection.
language public none language The IETF language tag (e.g. 'fr') for the language of this translation.
title public none string Translation of title of ShopSection.

Associations

Association Visibility Level Permission Scope Type Description
ShopSection public none ShopSection The ShopSection this translation belongs to.

Methods

getShopSectionTranslation

Method Name getShopSectionTranslation
Synopsis Retrieves a ShopSectionTranslation by shop_id, shop_section_id and language
HTTP Method GET
URI /shops/:shop_id/sections/:shop_section_id/translations/:language
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
shop_section_id Y   int
language Y   language
Requires OAuth N
Permission Scope none

createShopSectionTranslation

Method Name createShopSectionTranslation
Synopsis Creates a ShopSectionTranslation by shop_id, shop_section_id and language
HTTP Method POST
URI /shops/:shop_id/sections/:shop_section_id/translations/:language
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
shop_section_id Y   int
language Y   language
title N string
Requires OAuth Y
Permission Scope shops_rw

updateShopSectionTranslation

Method Name updateShopSectionTranslation
Synopsis Updates a ShopSectionTranslation by shop_id, shop_section_id and language
HTTP Method PUT
URI /shops/:shop_id/sections/:shop_section_id/translations/:language
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
shop_section_id Y   int
language Y   language
title N string
Requires OAuth Y
Permission Scope shops_rw

deleteShopSectionTranslation

Method Name deleteShopSectionTranslation
Synopsis Deletes a ShopSectionTranslation by shop_id, shop_section_id and language
HTTP Method DELETE
URI /shops/:shop_id/sections/:shop_section_id/translations/:language
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
shop_section_id Y   int
language Y   language
Requires OAuth Y
Permission Scope shops_rw

Open API v3New

Your developer account