{{ activeApiMethod.description }}
This service retrieves information regarding the requestor’s charge account and the postage products that the charge account is able to use.
Use this web service to:
HTTP Response Code: 200
HTTP Response Code: 400
| Element name | Description | Type | Length |
|---|---|---|---|
| account_number | The charge account for the location. | String | 10 |
| name | The name for the location. | String | 40 |
| valid_from | The beginning validity date when the charge account can be used. | Date YYYY-MM-DD | |
| valid_to | The ending validity date when the charge account can be used. | Date YYYY-MM-DD | |
| expired | Whether the charge account has an expired contract. | Boolean - true or false | |
| addresses | One or more addresses associated with the location. | Array | |
| type | The classification for the address. Value returned will be:
| String | |
| lines | The address lines for the address. Minimum of one address line, up to a maximum of three. The second address line can accommodate up to 60 characters. | String | 40 |
| suburb | The suburb for the address. | String | 40 |
| state | The state code for the address. Valid values are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA. | String | 3 |
| postcode | The postcode for the address. | String | 4 |
| details | Additional information associated with the location. | ||
| lodgement_postcode | The postcode where parcels for the location will be lodged. | String | 4 |
| abn | The merchant’s Australian Business Number (ABN). | String | 20 |
| acn | The merchant’s Australian Company Number (ACN). | String | 25 |
| contact_number | The phone number for the merchant at the location. | String | 30 |
| email_address | The email address for the merchant at the location. | String | 240 |
| postage_products | The postage products and services that can be used for this location. | Array | |
| type | The name for the postage product. | String | 30 |
| group | The product group name. Used for generating labels for items that reference the postage product. | String | 50 |
| product_id | The code that Australia Post uses to reference the postage product. | String | 5 |
| options | Options available for the postage product. | ||
| authority_to_leave_option | Whether the option for "authority to leave" is available for the postage product. | Boolean - true or false | |
| signature_on_delivery_option | Whether the option for "signature on delivery" is available for the postage product. | Boolean - true or false | |
| dangerous_goods_allowed | Whether Dangerous Goods can be sent with this postage product. | Boolean - true or false | |
| contract | Specific information related to the location’s contract for this product. | ||
| valid_from | The beginning validity date for when this product can be used. | Date YYYY-MM-DD | |
| valid_to | The ending validity date for when this product can be used. | Date YYYY-MM-DD | |
| expired | Whether the product can or cannot be used for this location. | Boolean - true or false | |
| volumetric_pricing | Whether volumetric pricing is applicable for this product. | Boolean - true or false | |
| cubing_factor | If volumetric pricing is applicable, the cubing factor to be applied in the calculation. | Decimal | 3.2 |
| max_item_count | The maximum number of items that can receive the discount price for the product. | Integer | |
| authority_to_leave_threshold | The limit on transit cover amounts when authority to leave is selected. | Decimal | 5.2 |
| features | Additional item features available for the product and its corresponding prices. This is optional, as some products may not have any additional features. | ||
| type | A unique string that identifies the type of feature. Currently, the only additional feature available is TRANSIT_COVER. | ||
| attributes | Additional attributes relevant to the feature. | ||
| maximum_cover | The maximum cover possible for the product. | Integer | |
| included_cover | The amount of transit cover bundled with this product. It means that this transit cover amount is included in the selected product. | Integer | |
| rate | The percentage rate used to calculate fees. eg: If the rate is 1.5 and the user opts for a cover of $500, the transit cover fee is 500*1.5/100 = $7.50. This includes tax. | Decimal | 2.2 |
| merchant_location_id | The ID issued to a merchant as part of the setup process. | String | |
| credit_blocked | Whether the merchant's account is credit blocked. Any account with this status will be forbidden from creating shipments or orders | Boolean - true or false |
| Element Name | Description | Type | Length |
|---|---|---|---|
| errors | The error codes and descriptions related to the action attempted. | Array | |
| code | The code associated with the error. | String | |
| name | The name category for the error. | String | |
| message | The human readable error message. | String | |
| context | A map of values that attempts to highlight important information that may have caused the error. This may or may not be populated depending on the type of error. | Map |
| Code | Name | Example Message |
|---|---|---|
| 41001 | CUSTOMER_NOT_FOUND | Customer information for the submitted customer identifier ACCOUNT could not be found. For further assistance please contact your Account Manager or call Australia Post on 13 21 31. |
| 41002 | ACCOUNT_NOT_FOUND | An account with the id of ACCOUNT cannot be found. Please check that the identifier is correct and submit the request again. |
| 41007 | CONTRACT_SETUP_ERROR | Contract information for the submitted contract identifier ACCOUNT could not be found. For further assistance please contact your Account Manager or call Australia Post on 13 21 31. |