Skip to content

Invoice Report API (0.1.0)

Invoice Report API

Download OpenAPI description
invoices-api.json
invoices-api.yaml
Languages
Servers
https://api.goshippo.com

List invoice files

Request

Returns a list of all invoice files. The returned list is arranged by date created, in descending order. Use page and limit to refine your list.

Security
Shippo_Token
Query
pagestring(Page)

Link to the next page

limitinteger(Limit)>= 1

The upper limit to the number of resources returned

Default 10
curl -i -X GET \
'https://api.goshippo.com/v2/reports/invoices?page=MTA=' \
-H 'Authorization: ShippoToken <API_TOKEN>'

Responses

Successful Response

Bodyapplication/json
page_infoobject(PageInfo)required

Link to the next page and previous page

resourcesArray of objects(Resources)
Response
application/json
{
  "page_info": {
    "next": "MjA=",
    "prev": "MA=="
  },
  "resources": [
    { … }
  ]
}

Retrieve invoice file

Request

Returns a redirect URL to download the invoice file content.

A successful response returns a 302 status code. Your client should automatically follow the redirected link to download the file. Some clients, such as Swagger UI, can include the authorization header when following the redirected link. This will cause the request to fail with a 400 Bad Request response. To avoid this issue, ensure that the authorization header is removed when the client follows the redirected URL.

Security
Shippo_Token
Path
file_idstring(File Id)required

Unique identifier of invoice file to be downloaded

curl -i -X GET \
'https://api.goshippo.com/v2/reports/invoices/4e43e2df-3e35-4985-b718-2d21e5078175' \
-H 'Authorization: ShippoToken <API_TOKEN>'

Responses

Successful Response: Redirect to download file

Headers
Locationstring(uri)

An URI to perform a HTTP GET to download the file content. It is RFC-7231 compliant https://datatracker.ietf.org/doc/html/rfc7231#section-6.4.3

Examples:

Redirect URI to download the file.

https://s3.amazonaws.com/your-bucket/your-file
Response
No content