REL documentation
Resources at supra-tenant scope: threepls, master logins, api provisioning; must use a token based upon Multi-Tenant credentials
| Rel (/rels/master/ + ) | On Billboard | Description |
|---|---|---|
| apicredential | an api credential, either specific to one tpl or not | |
| apicredentials | yes | Collection: of apicredential |
| apirole | an api role together with the set of policies defining the access rights of an ApiCredential assigned such role | |
| apiroles | yes | Collection: of apirole |
| attacheddoc | yes | a document attached to a warehouse transaction or batch |
| countries | yes | the list of countries with their states, to be referenced by country code in threepl records |
| handlerparameter | yes | a background process handler parameter |
| handlerparameters | yes | Collection: of handlerparameter |
| httptestdelete | yes | a pass-through http test endpoint for DELETE |
| httptestget | yes | a pass-through http test endpoint for GET |
| httptestpost | yes | a pass-through http test endpoint for POST |
| httptestput | yes | a pass-through http test endpoint for PUT |
| jobtypequeue | a mapping between HeadlessHorseman job type and Hangfire queue | |
| jobtypequeues | yes | Collection: of jobtypequeue |
| login | a master login | |
| logins | yes | Collection: of login |
| person | a person, to be referenced in threepl records | |
| persons | yes | Collection: of person |
| smallparcelstatistics | yes | a set of statistics regarding small parcel for a given threepl. Tpl 0 lists all TPLs. |
| threepl | a third party logistics company | |
| threeplactivate | yes | Operator: activate/deactivate a threepl |
| threeplconnection | Operator: to set the ConnectionString and optionally the RecordStatus of a ThreePl | |
| threepls | yes | Collection: of threepl |
| threeplsforbkgndprocess | yes | Collection: of threepl |
| threeplstatistics | yes | a set of statistics for a given threepl |
| threeplsummaries | yes | the list of third party logisitics company summaries |
| webhooksconfig | yes | master web hooks configuration |
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.