Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Account

Provides details for a Yodel account. <br />Information about the account number, alias, account type, and contact details is included in the response.

get/v4/shippingAccounts/yodel/{shippingAccountId}

Path parameters

shippingAccountIdstring required

Shipping Account Identifier <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Response

Returns the shipping account.

ShippingAccountIdstring uuid required

A unique identifier for each shipping account assigned by the system (ShippingAccountId), allowing for efficient reference and management of individual accounts within the system.

CarrierCodestring required

A unique identifier for the carrier associated with the shipping account. This code is typically alphanumeric and helps in identifying the specific carrier linked to the shipping account.

AccountNumberstring required

The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.

AccountType'Sandbox' | 'Production' required

Indicates whether the account is set up as a "sandbox" or "production" account. A Sandbox account is for testing and development, while a Production account is used for live shipments and transactions.

AccountNamestring required

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts.

AccountAliasstring required

A unique, user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.

AccountStatusstring required

The current status of the shipping account, which could denote whether it is enabled, disabled, or confirmed, helping users understand the account's usability.

ContactNamestring required

The name of the primary contact person for the shipping account, facilitating communication regarding shipping and account-related matters.

ContactNumberstring tel required

The phone number associated with the shipping account's primary contact person, facilitating communication regarding shipping inquiries, account management, and issue resolution.

ContractNumberstring required

The Yodel contract number.

ScheduleNumberstring required

The Yodel contracted schedule number.

LastUpdatedBystring required

The identifier (such as a username or system account) of the individual or system that last modified the shipping account information, ensuring accountability.

LastUpdatedDateUtcstring date-time required

A timestamp indicating the last time the shipping account details were updated, formatted in Coordinated Universal Time (UTC).

Example response

{
  "CarrierCode": "RM",
  "AccountNumber": "0123456789",
  "AccountName": "AB VideoGames",
  "AccountAlias": "JSL",
  "AccountStatus": "Enabled",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "ContractNumber": "1511116",
  "ScheduleNumber": "0000001",
  "LastUpdatedBy": "User A"
}