developer_guide:call_reference:getpackagesrequest
Table of Contents
GetPackagesRequest
Overview
GetPackagesRequest will return a list of all packages for any given store or language.
Learn More:
GetPackagesRequest
XML
<?xml version="1.0" encoding="utf-8"?> <GetPackagesRequest> <Username>string</Username> <Token>string</Token> <LanguageCode>integer</LanguageCode> </GetPackagesRequest>
Elements
Name | Type | Occurrence | Meaning |
---|---|---|---|
GetPackagesRequest | container | required | Parent Element |
Username | string | required | Merchant API Username (Not your Merchant Center login) |
Token | string | required | Hash of API Username and Password. Creating a Token |
LanguageCode | string | required | ISO Language Code (e.g. en-US). Learn More |
GetPackagesResponse
XML
<?xml version="1.0" encoding="utf-8"?> <GetPackagesResponse> <Ack>string</Ack> <Timestamp>timestamp</Timestamp> <Packages> <Package> <LinkID>string</LinkID> <PackageName>string</PackageName> <Description>string</Description> <Price>currency</Price> <TrialPrice>currency</TrialPrice> <TrialName>string</TrialName> <Disclaimer>string</Disclaimer> <TrialDescription>string</TrialDescription> </Package> </Packages> </GetPackagesResponse>
Elements
Name | Type | Occurrence | Meaning |
---|---|---|---|
GetPackagesResponse | container | required | Parent Element |
Ack | string | always | Success, Error, or Warning |
Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
Packages | container | always | A container element that contains a list of repeating package elements |
Package | container | always | A container element that contains the package elements |
Package/LinkID | string | always | The package LinkID |
Package/PackageName | string | always | The name of the package (e.g. XYZ Annual Magazine Subscription) |
Package/Price | currency | always | The price of the package |
Package/TrialPrice | currency | always | The trial price of the package |
Package/TrialName | string | always | The name of the trial (e.g. Try XYZ Magazine Free for 2 weeks) |
Package/Disclaimer | string | always | A custom message that accompanies the pricing terms (e.g. Plus shipping, tax, and handling) |
Package/TrialDescription | string | always | A description of the trial. (e.g. You will receive 2 issues of XYZ Magazine completely free of charge. If you don't wish to continue, you can simply cancel your subscription before the end of the trial.) |
developer_guide/call_reference/getpackagesrequest.txt · Last modified: 2012/02/25 23:39 by matt