List shipments - Fohlio API

Error

A valid request URL is required to generate request examples

[
  {
    "id": 123,
    "currency": "<string>",
    "deliver_by": "2023-12-25",
    "delivery_date": "2023-12-25",
    "estimated_ship_date": "2023-12-25",
    "shipped_date": "2023-12-25",
    "received_date": "2023-12-25",
    "status": "not_shipped",
    "notes": "<string>",
    "tracking_number": "<string>",
    "items": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "spec_quantity": 123,
        "ordered": 123,
        "received": 123,
        "shipped": 123
      }
    ],
    "shipping_client": {
      "id": 123,
      "name": "<string>",
      "data": {},
      "addresses": [
        {
          "id": 123,
          "name": "<string>",
          "phone": "<string>",
          "post_code": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>"
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>"
        }
      ],
      "category": {
        "id": 123,
        "type": "client"
      }
    },
    "supplier": {
      "id": 123,
      "name": "<string>",
      "data": {},
      "addresses": [
        {
          "id": 123,
          "name": "<string>",
          "phone": "<string>",
          "post_code": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>"
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>"
        }
      ],
      "category": {
        "id": 123,
        "type": "client"
      }
    },
    "purchase_order_ids": [
      123
    ]
  }
]

GET

shipments

Error

A valid request URL is required to generate request examples

[
  {
    "id": 123,
    "currency": "<string>",
    "deliver_by": "2023-12-25",
    "delivery_date": "2023-12-25",
    "estimated_ship_date": "2023-12-25",
    "shipped_date": "2023-12-25",
    "received_date": "2023-12-25",
    "status": "not_shipped",
    "notes": "<string>",
    "tracking_number": "<string>",
    "items": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "spec_quantity": 123,
        "ordered": 123,
        "received": 123,
        "shipped": 123
      }
    ],
    "shipping_client": {
      "id": 123,
      "name": "<string>",
      "data": {},
      "addresses": [
        {
          "id": 123,
          "name": "<string>",
          "phone": "<string>",
          "post_code": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>"
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>"
        }
      ],
      "category": {
        "id": 123,
        "type": "client"
      }
    },
    "supplier": {
      "id": 123,
      "name": "<string>",
      "data": {},
      "addresses": [
        {
          "id": 123,
          "name": "<string>",
          "phone": "<string>",
          "post_code": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>"
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>"
        }
      ],
      "category": {
        "id": 123,
        "type": "client"
      }
    },
    "purchase_order_ids": [
      123
    ]
  }
]

Authorizations

authorization

string

header

required

Query Parameters

page

integer

default:1

per_page

integer

default:25

Required range: 1 <= x <= 50

project_ids

integer[]

supplier_ids

integer[]

po_label

string

status

enum<string>[]

Available options:

not_shipped,

arrival_expected,

received

tracking_number

string

Response

integer

currency

string | null

deliver_by

string<date> | null

delivery_date

string<date> | null

estimated_ship_date

string<date> | null

shipped_date

string<date> | null

received_date

string<date> | null

status

enum<string>

Available options:

not_shipped,

arrival_expected,

received

notes

string | null

tracking_number

string | null

items

object[]

Show child attributes

items.id

integer

items.name

string | null

items.description

string | null

items.spec_quantity

number

items.ordered

number

items.received

number

items.shipped

number

shipping_client

object

Show child attributes

shipping_client.id

integer

shipping_client.name

string

shipping_client.data

object

The details of the contact encoded in JSON format.

shipping_client.addresses

object[]

Show child attributes

shipping_client.addresses.id

integer

shipping_client.addresses.name

string

shipping_client.addresses.phone

string | null

shipping_client.addresses.post_code

string | null

shipping_client.addresses.address_line_1

string | null

shipping_client.addresses.address_line_2

string | null

shipping_client.addresses.city

string | null

shipping_client.addresses.state

string | null

shipping_client.addresses.country

string | null

shipping_client.people

object[]

Show child attributes

shipping_client.people.id

integer

shipping_client.people.name

string | null

shipping_client.people.email

string | null

shipping_client.people.phone

string | null

shipping_client.people.position

string | null

shipping_client.people.note

string | null

shipping_client.category

object

Show child attributes

shipping_client.category.id

integer

shipping_client.category.type

enum<string>

Available options:

client,

supplier,

general_contractor,

manufacture,

warehouse

supplier

object

Show child attributes

supplier.id

integer

supplier.name

string

supplier.data

object

The details of the contact encoded in JSON format.

supplier.addresses

object[]

Show child attributes

supplier.addresses.id

integer

supplier.addresses.name

string

supplier.addresses.phone

string | null

supplier.addresses.post_code

string | null

supplier.addresses.address_line_1

string | null

supplier.addresses.address_line_2

string | null

supplier.addresses.city

string | null

supplier.addresses.state

string | null

supplier.addresses.country

string | null

supplier.people

object[]

Show child attributes

supplier.people.id

integer

supplier.people.name

string | null

supplier.people.email

string | null

supplier.people.phone

string | null

supplier.people.position

string | null

supplier.people.note

string | null

supplier.category

object

Show child attributes

supplier.category.id

integer

supplier.category.type

enum<string>

Available options:

client,

supplier,

general_contractor,

manufacture,

warehouse

purchase_order_ids

integer[]

Get a shipment by ID Get a supplier invoice by ID

⌘I

API Reference

Authorizations

Query Parameters

Response