Get Product

Resource:
/api/products/<<product id>>
Method:
GET

Returns a product

Arguments

  • Product ID: The onDemand Project ID. You will receive this ID from Get Project

Return Codes

Status Code Comments
Success 200 Successful request
Bad Request 400  
Unauthorized 401

The request did not

pass authentication or

the customer is not a

member of an enterprise

site.

Not Found 404

The URL does not relate

to a product that the

merchant owns.

Response Body

The response body shows information about the product.

Property Type Comments
SKUs
Container

Container of SKU

elements

SKUs

.SKU
Container Container of a SKUs

SKUs

.SKU

.SKUNumber

String SKU Number
AssetID
Integer

Internal onDemand ID

for the Asset.

URL
String

String to download full

details of the product.

ProjectID
Integer

ID of the project that

was used to translate

this item.  If SKU was

submitted multiple

times, it is the most

recent project.

SourceLanguage

.LanguageCode
String

See LanguageCode in

glossary

TargetLanguages
Container

Container containing

target languages that

the product was already

translated into.

TargetLanguages

.TargetLanguage

.LanguageCode

String

See LanguageCode in

glossary

TargetLanguagess

.TargetLanguage

.Status

String

The status of the

translation

TargetLanguages

.TargetLanguage

.ProjectURL

String

URL to retrieve the

project information.

Product

.TargetLanguages

.TargetLanguage

.DownloadURL

String

URL to download the

translated file.  See

GetTranslation

Product

.TargetLanguages

.TargetLanguage

.Translation

Container

Contains the translated

content

Response Example

<Product>
    <SKUs>
        <SKU>
            <SKUNumber>123</SKUNumber>
        </SKU>
    </SKUs>
    <AssetID>9999</AssetID>
    <ProjectURL>https://</ProjectURL>
    <ProjectID>1234</ProjectID>
    <SourceLanguage>
        <LanguageCode>en-gb</LanguageCode>
    </SourceLanguage>
    <TargetLanguages>
        <TargetLanguage>
            <LanguageCode>de-de</LanguageCode>
            <Status>Complete</Complete>
            <ProjectURL>https://...</ProjectURL>
            <DownloadURL>https://...</DownloadURL>
            <Translation>
                ...
            </Translation>
        </TargetLanguage>
        <TargetLanguage>
            <LanguageCode>fr-fr</LanguageCode>
            <Status>Complete</Complete>
            <ProjectURL>https://...</ProjectURL>
            <DownloadURL>https://..</DownloadURL>
            <Translation>
                <Title>...</Title>
                <Description>
                <!-- Same structure as submitted -->
                </Description>
                <PrimaryCategory>123</PrimaryCategory>
                <SKUs>
                    <SKU>
                        <SKUNumber>123</SKUNumber>
                        <ItemSpecifics>
                            <ItemSpecific>
                                <SourceName>Colour</SourceName>
                                <Name>Culeur</Name>
                                <Value>Blanc</Value>
                            </ItemSpecific>
                            <ItemSpecific>
                                <SourceName>Size</SourceName>
                                <Name>Taille</Name>
                                <Value>Grande</Value>
                            </ItemSpecific>
                        </ItemSpecifics>
                    </SKU>
                </SKUs>
            </Translation>
        </TargetLanguage>
    </TargetLanguages>
</Product>