developer_guide:call_reference:getpackagesrequest
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| developer_guide:call_reference:getpackagesrequest [2010/01/06 01:00] – matt | developer_guide:call_reference:getpackagesrequest [2012/02/25 23:39] (current) – [GetPackagesRequest] matt | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== GetPackagesRequest | + | ====== GetPackagesRequest ====== |
| + | ==== Overview ==== | ||
| - | GetPackagesRequest will return a list of all packages for any given store or language. | + | **GetPackagesRequest** will return a list of all packages for any given store or language. |
| - | **View:** | + | **Learn More:** |
| * [[: | * [[: | ||
| Line 11: | Line 12: | ||
| * [[: | * [[: | ||
| * [[: | * [[: | ||
| - | |||
| ===== GetPackagesRequest ===== | ===== GetPackagesRequest ===== | ||
| - | |||
| - | |||
| - | ==== Overview ==== | ||
| - | |||
| - | The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box. | ||
| - | |||
| - | |||
| ==== XML ==== | ==== XML ==== | ||
| Line 43: | Line 36: | ||
| ^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
| - | | GetPackagesRequest | container | required | Parent Element | | + | | **GetPackagesRequest** | container | required | Parent Element | |
| - | | Username | string | required | Merchant API username | + | | Username | string | required | Merchant API Username |
| - | | Token | string | required | Your application' | + | | Token| string | required | Hash of API Username and Password. [[:developer_guide: |
| - | | LanguageCode | string | required | The language your package details will be displayed | + | | LanguageCode | string | required | ISO Language Code (e.g. en-US). [[: |
| ===== GetPackagesResponse ===== | ===== GetPackagesResponse ===== | ||
| - | |||
| - | |||
| - | ==== Overview ==== | ||
| - | |||
| - | The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box. | ||
| - | |||
| Line 65: | Line 52: | ||
| <?xml version=" | <?xml version=" | ||
| < | < | ||
| - | <Status> | + | <Ack> |
| < | < | ||
| < | < | ||
| Line 72: | Line 59: | ||
| < | < | ||
| < | < | ||
| - | < | + | < |
| - | < | + | < |
| < | < | ||
| < | < | ||
| Line 87: | Line 74: | ||
| ^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
| - | | GetPackagesResponse | container | required | Parent Element | | + | | **GetPackagesResponse** | container | required | Parent Element | |
| - | | Status | + | | Ack | string | always | Success, Error, or Warning | |
| | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | | 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 | | + | | **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** | container | always | A container element that contains the package elements | |
| - | | LinkID | string | always | The package LinkID | | + | | Package/LinkID | string | always | The package LinkID | |
| - | | PackageName | string | always | The name of the package (e.g. XYZ Annual Magazine Subscription) | | + | | Package/PackageName | string | always | The name of the package (e.g. XYZ Annual Magazine Subscription) | |
| - | | Price | double | + | | Package/Price | currency |
| - | | TrialPrice | double | + | | Package/TrialPrice | currency |
| - | | TrialName | string | always | The name of the trial (e.g. Try XYZ Magazine Free for 2 weeks) | | + | | Package/TrialName | string | always | The name of the trial (e.g. Try XYZ Magazine Free for 2 weeks) | |
| - | | Disclaimer | string | always | A custom message that accompanies the pricing terms (e.g. Plus shipping, tax, and handling) | | + | | Package/Disclaimer | string | always | A custom message that accompanies the pricing terms (e.g. Plus shipping, tax, and handling) | |
| - | | 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.) | | + | | 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.1262757613.txt.gz · Last modified: 2010/01/04 23:00 (external edit)