APIs - REST FULL - TPL

To access the methods, it is necessary to follow the instructions below:

  1. Request your credentials (apikey, token, and email) or SANDBOX account credentials from the sales/projects team.
  2. Use the authentication method (get/auth) with your credentials to obtain the service consumption TOKEN.

All methods use POST; however, the method naming will include GET or PUT for guidance. Example below:

  • <base url>/api/get/auth - Obtain authentication token
  • <base url>/api/put/order - Insert an order

The base URL is https://oms.tpl.com.br/api; the staging or production environment is defined by the credentials used.

Methods must mandatory use UTF8


About Categories Authentication: Collection of methods for acquiring the token to use the platform´s API collection.
Storage: Set of methods for product registration/inquiry and stock balances.
Inbound: Services for receiving goods through invoices, as well as monitoring them in the logistics process.
Outbound: Methods for inserting orders, attachments, labels, and invoices so that orders enter the production line.
Carriers: Routines to query the carriers enabled for your account, as well as listing orders linked to them.
BID: Service intended for freight quotation from your warehouse to the end consumer (linked to your shopping cart engine).
Webhook: Configuration of triggers for monitoring outbound and inbound movements.

Note: In JSONs/Requests where a tag contains an "*" preceding its name, it indicates that it is mandatory.