Module @shipgenius/oms/client

The client object used to connect to the Shipgenius OMS API

Default export is ShipGeniusOmsClient

Namespaces

gql_types: Internal-use interfaces describing raw GQL input/output values

Enumerations

ServerEnvironment: The type of ShipGenius OMS API server connected to

Classes

GraphqlError: Information about errors returned by the GraphQL API
HttpError: An error occuring from a non-ok HTTP response

Interfaces

ServerEnvironmentConnection: Specification of the server to connect to using server's environment
ServerUrlConnection: Specification of the server to connect to using the server's url
ShipGeniusOmsClientConstructorOptions: Additional options for the connection, such as the api version.

Type Aliases

ServerConnectionSpecification: The server to connect to
StrippedResponse: Standard fetch Response object with some fields removed

References

client → ShipGeniusOmsClient