Documentation Powered by ReDoc

Globl Shipping API (1.0.0)

Download OpenAPI specification:Download

Authentication

Bearer Auth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "Authorization: Bearer <token>"

auth

Login

Returns a token that can be used for Bearer Auth

Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Logout

Invalidates the token used to authenticate this request, disabling its use in future requests.

Authorizations:
None

Responses

Current User

Returns the currently authenticated user

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "username": "string"
}

shipping

Retrieve available services

Retrieve a list of specific services available for a vendor.

Authorizations:
None
path Parameters
vendor name
string

Add the string name of the vendor you wish to list as a parameter. This parameter is optional if you only have access to a single vendor, otherwise it must be specified.

Responses

Response samples

Content type
application/json
{
  • "services": [
    ]
}

Create an order

Create an order and assign it to a suitable open shipping manifest. A manifest will be opened if required.

Authorizations:
None
Request Body schema: application/json
required
Array of objects (OrderItem) non-empty
label_type
string or null
Default: null
order_ref
string or null
Default: null
required
object (PersonEntity)
required
object (Address)
required
object (PersonEntity)
required
object (Address)
service
required
any
Enum: "tracked" "untracked" "<one of the values returned by GET /services>"

The shipping service to use for this order

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "label_type": null,
  • "order_ref": null,
  • "recipient": {
    },
  • "recipient_address": {
    },
  • "sender": {
    },
  • "sender_address": {
    },
  • "service": "tracked"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "items": [
    ],
  • "label": {
    },
  • "manifest_id": "string",
  • "order_ref": null,
  • "recipient": {
    },
  • "recipient_address": {
    },
  • "sender": {
    },
  • "sender_address": {
    },
  • "service": "string",
  • "service_requested": "string",
  • "tracking": {
    }
}

Retrieve an order

Retrieve a previously created order

Authorizations:
None
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "items": [
    ],
  • "label": {
    },
  • "manifest_id": "string",
  • "order_ref": null,
  • "recipient": {
    },
  • "recipient_address": {
    },
  • "sender": {
    },
  • "sender_address": {
    },
  • "service": "string",
  • "service_requested": "string",
  • "tracking": {
    }
}

Retrieve a manifest

Retrieve a manifest

Authorizations:
None
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "closed_at": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "error": null,
  • "id": "string",
  • "label": {
    },
  • "n_orders": 0,
  • "orders": null,
  • "pallet_count": null,
  • "processing": true,
  • "service": "string",
  • "status": "string",
  • "tracking": {
    }
}

Close all open manifests

Close all open manifests and return them

Authorizations:
None
Request Body schema: application/json
Array of objects or null (CloseManifestMetadata)
Default: null
vendor
string or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "manifest_metadata": null,
  • "vendor": null
}

Response samples

Content type
application/json
{
  • "manifests": [
    ]
}

Retrieve an order label

Authorizations:
None
path Parameters
id
required
string

The id of the order

Responses

Retrieve a manifest label

Authorizations:
None
path Parameters
id
required
string

The id of the manifest

Responses