ShippingAccount
A shipping account: the access of the Wawi to a shipping provider for one purpose. Only what identifies and classifies the account is part of the API. User name, password, tokens, customer and billing numbers, bank data and the sender address are never part of the API; ‘credentialsStatus’ only says whether they are set.
ShippingAccountFields
The ID of the shipping account.
The name the account has in the Wawi.
The shipping provider the account belongs to.
What the account is used for, as the key of a capability: LABEL_CREATION, RETURN_LABELS or TRACKING_ACCOUNT. Which of them a provider supports is in 'ShippingProvider.capabilities'.
The account this one refines for a single company. Empty for the account that applies to all companies.
The company the account is for. Empty for an account that applies to all companies; set exactly when 'parentAccountId' is set.
Whether it is a test account of the provider. A test account cannot be changed and not deleted.
Whether the credentials of the account are set, as a stable key in UPPER_SNAKE. Known keys: NOT_CONFIGURED (no credentials are stored, or they are incomplete), CONFIGURED (credentials are stored), TOKEN_EXPIRED (the account signs in with a token that is no longer valid; it has to be authorised again in the Wawi). New keys can be added; a client treats a key it does not know as not usable. The credentials themselves are never part of the API.
Whether a shipping method uses the account. Computed; an account in use cannot be deleted.
Was this page helpful?