Include

Some API endpoints has an include URL Search Parameter that let you specify extra info to be returned in your request.

Example include in Swagger API docs

Example URL parameter

?include=customer,customer.tags

Nested includes

You can add an include for nested data.

Here’s a list of nested data that is common to include:

customer

• customer.tags

lines_extract

• lines_extract.service
• lines_extract.sku

inbound_lots

• inbound_lots.lot
• inbound_lots.sku

outbound_lots

• outbound_lots.lot
• outbound_lots.sku