List Staging Invoices

List all staging invoices for the tenant.

Returns a paginated list of staging invoices that belong to the requesting tenant, with support for filtering by status, invoice number, service provider, and other fields.

SecurityAPIKeyHeader
Request
query Parameters
origin__company_name
string (Origin Company Name)
origin__company_name__icontains
string (Origin Company Name Icontains)
origin__location_name
string (Origin Location Name)
origin__location_name__icontains
string (Origin Location Name Icontains)
origin__external_reference
string (Origin External Reference)
origin__external_reference__icontains
string (Origin External Reference Icontains)
origin__line_1
string (Origin Line 1)
origin__line_1__icontains
string (Origin Line 1 Icontains)
origin__locality
string (Origin Locality)
origin__region
string (Origin Region)
origin__country
string (Origin Country)
origin__postal_code
string (Origin Postal Code)
origin__radius
number (Origin Radius)
origin__lat
number (Origin Lat)
origin__lon
number (Origin Lon)
destination__company_name
string (Destination Company Name)
destination__company_name__icontains
string (Destination Company Name Icontains)
destination__location_name
string (Destination Location Name)
destination__location_name__icontains
string (Destination Location Name Icontains)
destination__external_reference
string (Destination External Reference)
destination__external_reference__icontains
string (Destination External Reference Icontains)
destination__line_1
string (Destination Line 1)
destination__line_1__icontains
string (Destination Line 1 Icontains)
destination__locality
string (Destination Locality)
destination__region
string (Destination Region)
destination__country
string (Destination Country)
destination__postal_code
string (Destination Postal Code)
destination__radius
number (Destination Radius)
destination__lat
number (Destination Lat)
destination__lon
number (Destination Lon)
search
string (Search)
order_by
string (Order By)
invoiceable_id
string (Invoiceable Id)
invoiceable_id__in
string (Invoiceable Id In)
invoiceable_mode
string (Invoiceable Mode)
invoiceable_mode__in
string (Invoiceable Mode In)
invoiceable_groups_external_ids__in
string (Invoiceable Groups External Ids In)
invoiceable_groups_external_ids__not_in
string (Invoiceable Groups External Ids Not In)
invoiceable_shipwell_custom_data_id
string (Invoiceable Shipwell Custom Data Id)
invoiceable_shipwell_custom_data_value
string (Invoiceable Shipwell Custom Data Value)
service_provider_scac
string (Service Provider Scac)
service_provider_scac__icontains
string (Service Provider Scac Icontains)
invoiceable_reference_number
string (Invoiceable Reference Number)
service_provider_name
string (Service Provider Name)
service_provider_name__contains
string (Service Provider Name Contains)
service_provider_name__icontains
string (Service Provider Name Icontains)
invoice_number
string (Invoice Number)
created_at__lt
string <date-time> (Created At Lt)
created_at__lte
string <date-time> (Created At Lte)
created_at__gt
string <date-time> (Created At Gt)
created_at__gte
string <date-time> (Created At Gte)
created_at
string <date-time> (Created At)
updated_at
string <date-time> (Updated At)
total_amount
string <decimal> (Total Amount)
due_date
string <date> (Due Date)
due_date__lt
string <date> (Due Date Lt)
due_date__lte
string <date> (Due Date Lte)
due_date__gt
string <date> (Due Date Gt)
due_date__gte
string <date> (Due Date Gte)
invoice_date
string <date> (Invoice Date)
invoice_date__lt
string <date> (Invoice Date Lt)
invoice_date__lte
string <date> (Invoice Date Lte)
invoice_date__gt
string <date> (Invoice Date Gt)
invoice_date__gte
string <date> (Invoice Date Gte)
delivery_date
string <date> (Delivery Date)
delivery_date__lt
string <date> (Delivery Date Lt)
delivery_date__lte
string <date> (Delivery Date Lte)
delivery_date__gt
string <date> (Delivery Date Gt)
delivery_date__gte
string <date> (Delivery Date Gte)
status
string (StagingInvoiceStatus)

Status of a staging invoice.

Enum: "CREATED" "DONE" "REJECTED"
status__in
string (Status In)
status__not_in
string (Status Not In)
invoice_source
string (FreightInvoiceSource)

An enumeration.

Enum: "CARRIER_GENERATED" "EDI_210" "DFM" "SHIPWELL_WEB" "UPLOADED_INVOICE" "SWIFTY" "AUTO_GENERATED" "API"
invoice_source__in
string (Invoice Source In)
external_id
string (External Id)
archived
boolean (Archived)
Default: false
remit_to__name
string (Remit To Name)
stops__address
string (Stops Address)
stops__address__contains
string (Stops Address Contains)
stops__address__icontains
string (Stops Address Icontains)
stops__company_name
string (Stops Company Name)
stops__company_name__in
string (Stops Company Name In)
stops__company_name__contains
string (Stops Company Name Contains)
stops__company_name__icontains
string (Stops Company Name Icontains)
stops__location_name
string (Stops Location Name)
stops__location_name__in
string (Stops Location Name In)
stops__location_name__icontains
string (Stops Location Name Icontains)
stops__external_reference
string (Stops External Reference)
stops__external_reference__in
string (Stops External Reference In)
stops__external_reference__icontains
string (Stops External Reference Icontains)
page
integer (Page) >= 1
Default: 1
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Responses
200

Successful Response

Response Headers
Link
string

| Corresponds to the Link specification. Only 1 parameter for each link is valid - rel. Within rel, only a few values are valid:

  • rel="next" - If included, there is a next page of results accessed via this url. Will not be included in the response of the last page.
  • rel="prev" - If included, there is a previous page of results access via this url. Will not be included in the response of the first page.
  • rel="first" - A link to access the first page of results, always included
  • rel="last" - If included, a link to access the last page of results

So a first page of results might have a Link header like:

<https://api.shipwell.com/some/path?page=2>; rel="next", <https://api.shipwell.com/some/path?page=1>; rel="first" <https://api.shipwell.com/some/path?page=20>; rel="last"

An intermediary page of results might have a Link header like:

<https://api.shipwell.com/some/path?before=01GK55HVSR279AH0TRWG6FNNJJ>; rel="prev", <https://api.shipwell.com/some/path?before=01GK55HNXR73T4TFBZ79670AXP>; rel="next", <https://api.shipwell.com/some/path?after=01GK55K2WSGEJCQ4D26S5APRHQ>; rel="first" <https://api.shipwell.com/some/path?before=01GK55KAGHB5QYKPYGDB0H2KRC>; rel="last"
Response Schema: application/json
required
Array of objects (Data)
count
required
integer (Count)

Number of the items within the 'data' array.

total_count
integer (Total Count)

Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.

required
object (PaginationLinks)
400

Validation Error

get/staging-invoices
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "count": 0,
  • "total_count": 0,
  • "links": {}
}
Copyright © Shipwell 2025. All right reserved.