Class SellersAPI

Sellers API endpoints

Hierarchy

SellersAPI

Index

Constructors

Properties

Methods

addSandboxCarriers createSandboxSeller createSellerApiKey deleteSellerApiKey listSandboxSellerIds listSellerApiKeys

Constructors

constructor

new SellersAPI(client: AxiosInstance): SellersAPI
Parameters
- client: AxiosInstance
Returns SellersAPI
- Defined in javascript/src/sellers/api.ts:21

Properties

`Private` client

client: AxiosInstance

Methods

addSandboxCarriers

addSandboxCarriers(props: SE.SandboxableMutation<SE.SandboxMethodParams>): Promise<AxiosResponse<void, any>>
Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
Parameters
- props: SE.SandboxableMutation<SE.SandboxMethodParams>
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/sellers/api.ts:99

createSandboxSeller

createSandboxSeller(__namedParameters: SE.SandboxMethodParams): Promise<AxiosResponse<void, any>>
Creates a sandbox seller account for a given seller ID you can pass in a flag to try to reuse the carrier connection.
Parameters
- __namedParameters: SE.SandboxMethodParams
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/sellers/api.ts:90

createSellerApiKey

createSellerApiKey(__namedParameters: SE.SandboxableMutation<SE.CreateSellerApiKeyParams>): Promise<AxiosResponse<SE.SellerApiKeyEncrypted, any>>
Creates an API Key for a Seller ID
Parameters
- __namedParameters: SE.SandboxableMutation<SE.CreateSellerApiKeyParams>
Returns Promise<AxiosResponse<SE.SellerApiKeyEncrypted, any>>
- Defined in javascript/src/sellers/api.ts:44

deleteSellerApiKey

deleteSellerApiKey(__namedParameters: SE.SandboxableMutation<SE.DeleteSellerApiKeyParams>): Promise<AxiosResponse<void, any>>
Deletes an API Key. Ownership is enforced server-side from the gateway auth header.
Parameters
- __namedParameters: SE.SandboxableMutation<SE.DeleteSellerApiKeyParams>
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/sellers/api.ts:64

listSandboxSellerIds

listSandboxSellerIds(__namedParameters: SE.ListSandboxSellersParams): Promise<AxiosResponse<string[], any>>
Given a seller ID, returns a list of sandbox seller IDs for that seller.
Parameters
- __namedParameters: SE.ListSandboxSellersParams
Returns Promise<AxiosResponse<string[], any>>
- Defined in javascript/src/sellers/api.ts:28

listSellerApiKeys

listSellerApiKeys(props: {
isSandbox?: boolean;
}): Promise<AxiosResponse<SE.SellerApiKeyMasked[], any>>
Returns a list of API Keys for the seller resolved from the gateway auth header.
Parameters
- props: {
  isSandbox?: boolean;
  }
  - Optional isSandbox?: boolean
Returns Promise<AxiosResponse<SE.SellerApiKeyMasked[], any>>
- Defined in javascript/src/sellers/api.ts:35

Generated using TypeDoc