Interface ShipgeniusGraphqlErrorExtension

Extra information about the error

Responses from the Shipgenius OMS GraphQL server will usually implement this interface in GraphqlErrorResponse.extensions

interface ShipgeniusGraphqlErrorExtension {
    additional_details: JsonObject;
    code: string;
    http_status: number;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

additional_details code http_status

Properties

additional_details

additional_details: JsonObject

Further free-form details about the error

code

code: string

An error code identifying the type of error

Remarks

There is not currently an enum of these values, but there will be in the future

http_status

http_status: number

An equivalent HTTP status

Settings

Member Visibility

On This Page

Properties