- Management API\u2014Terminal ordering read<\/li>
- Management API\u2014Terminal ordering read and write<\/li><\/ul>
If you have a Terminal API integration with cloud-based communications<\/a>, you can use the existing API key that you use for Terminal API requests.<\/td>\n<\/tr>\n\n Webhooks<\/a><\/strong><\/td>\n Optionally subscribe to Terminal order update<\/a> webhooks.<\/td>\n<\/tr>\n \n Limitations<\/strong><\/td>\n Note the following: - You can only create orders for live terminals using the Management API. To order test terminals, you need to submit a sales order<\/a> in your test Customer Area<\/a>.<\/li>
- Requests to live Management API endpoints related to terminal orders are subject to rate limits<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Products and orders<\/h2>\n
You can order products for a company account or a merchant account. A product can be:<\/p>\n
- \n
- A box containing a payment terminal and default items like a power cable.<\/li>\n
- An accessory, like a privacy shield, a stylus pen, or a replacement power cable.<\/li>\n<\/ul>\n
Apart from the products, an order includes:<\/p>\n
- \n
- A billing entity<\/strong> for the company or merchant account. This is where we charge the order to. We create billing entities for you based on the details you provided when you applied for the accounts.<\/li>\n
- A shipping location<\/strong> for the company or merchant account. This is where we send the order. A shipping location is linked to a company account or a merchant account. You create shipping locations yourself.<\/li>\n<\/ul>\n
Regional compatibility<\/h3>\n
You can only use the terminals in the country or region where you ordered them for. This is because the wireless communications modem inside the terminals is specific to the region. The terminals will not work in a different country or region, even with a region-specific power cord.<\/p>\n
For example, if you ordered a European terminal having delivered them to the US, it would not work even with a US power cord.<\/p>\n
Get the product ID<\/h2>\n
An order for terminal products must contain the IDs of the products you want to order. To retrieve those IDs and decide what to order:<\/p>\n
- \n
- \n
Get the ID of the account you want to order products for. You need to specify that ID in the URL of later requests.<\/p>\n
- \n
- For the company ID, make a GET \/companies<\/a> request.<\/li>\n
- For the merchant ID, make a GET \/merchants<\/a> request.<\/li>\n<\/ul>\n<\/li>\n
- \n
Get a list of payment terminal models you can order for your company or merchant account. Use the following endpoints:<\/p>\n
- \n
- GET \/companies\/{companyId}\/terminalModels<\/a><\/li>\n
- GET \/merchants\/{merchantId}\/terminalModels<\/a><\/li>\n<\/ul>\n
\n<\/code-sample>\n<\/div>\n The response returns the
id<\/code> andname<\/code> of the various models. You can use theid<\/code> as a query parameter to filter the product list in the next step.<\/p>\n\n<\/code-sample>\n<\/div>\n<\/li>\n - \n
Get a list of products you can order for your company or merchant account. Use the following endpoints, with the
country<\/code> as a query parameter:<\/p>\n- \n
- GET \/companies\/{companyId}\/terminalProducts<\/a><\/li>\n
- GET \/merchants\/{merchantId}\/terminalProducts<\/a><\/li>\n<\/ul>\n
These are the query parameters to filter the paginated response:<\/p>\n
- GET \/merchants\/{merchantId}\/terminalProducts<\/a><\/li>\n<\/ul>\n
- GET \/merchants\/{merchantId}\/terminalModels<\/a><\/li>\n<\/ul>\n
- For the merchant ID, make a GET \/merchants<\/a> request.<\/li>\n<\/ul>\n<\/li>\n
- For the company ID, make a GET \/companies<\/a> request.<\/li>\n
- A shipping location<\/strong> for the company or merchant account. This is where we send the order. A shipping location is linked to a company account or a merchant account. You create shipping locations yourself.<\/li>\n<\/ul>\n
- A billing entity<\/strong> for the company or merchant account. This is where we charge the order to. We create billing entities for you based on the details you provided when you applied for the accounts.<\/li>\n
- Requests to live Management API endpoints related to terminal orders are subject to rate limits<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
- You can only create orders for live terminals using the Management API. To order test terminals, you need to submit a sales order<\/a> in your test Customer Area<\/a>.<\/li>
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n