Goflow API

https://goflow.com/api-spec
Admin
The Goflow API allows developers to programmatically manage orders, products, inventory, purchasing,...
Tokens:58,464
Snippets:134
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Purchase Order Response Sample

Source: https://goflow.com/api-spec/index

Example JSON structure for a successful response when retrieving purchase order details.

```JSON
{
  "id": 0,
  "type": "standard",
  "purchase_order_number": "string",
  "date": "2019-08-24T14:15:22Z",
  "status": "awaiting_receipt",
  "warehouse": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "vendor": {
    "id": 0,
    "name": "string"
  },
  "vendor_purchase_order": {
    "purchase_order_number": "string",
    "is_submitted": true
  },
  "charges": [
    {
      "amount": 0,
      "currency": {
        "code": "unknown",
        "exchange_rate": 0
      },
      "type": "discount"
    }
  ],
  "shipment": {
    "expected_at": "2019-08-24T14:15:22Z",
    "type": "small_parcel",
    "carrier": "amazon_logistics",
    "shipping_method": "amazon_logistics_us_bulk",
    "address": {
      "company": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "country_code": "ad",
      "email": "string",
      "phone": "string",
      "phone_extension": "string"
    }
  },
  "lines": [
    {
      "id": 0,
      "product": {
        "id": 0,
        "item_number": "string",
        "name": "string"
      },
      "vendor_item_number": "string",
      "quantity": {
        "amount": 0,
        "measure": {
          "amount": 0,
          "abbreviation": "string"
        }
      },
      "price": {
        "amount": 0,
        "currency": {
          "code": "unknown",
          "exchange_rate": 0
        }
      },
      "units_received": 0
    }
  ],
  "tags": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "notes": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "text": "string"
    }
  ],
  "summary": {
    "subtotal": {
      "amount": 0,
      "currency": {
        "code": "unknown",
        "exchange_rate": 0
      }
    },
    "total": {
      "amount": 0,
      "currency": {
        "code": "unknown",
        "exchange_rate": 0
      }
    }
  },
  "meta": {
    "created": {
      "at": "2019-08-24T14:15:22Z",
      "by": {
        "type": "user",
        "user": {
          "username": "string"
        }
      }
    }
  }
}
```

--------------------------------

### Goflow API Request Payload Sample

Source: https://goflow.com/api-spec/index

An example JSON payload demonstrating how to structure a request to the Goflow API. This sample includes common fields like columns, order_by, limit, format, and filters with example values.

```JSON
{
  "columns": [
    "string"
  ],
  "order_by": [
    {
      "field": "product_id",
      "direction": "asc"
    }
  ],
  "limit": 1000000,
  "format": "json",
  "filters": {
    "product_brand": {
      "values": [
        "string"
      ],
      "operator": "in"
    },
    "product_buyer_user_name": {
      "values": [
        "string"
      ],
      "operator": "in"
    },
    "product_category": {
      "values": [
        "string"
      ],
      "operator": "in"
    },
    "product_item_number": {
      "values": [
        "string"
      ],
      "operator": "in"
    },
    "product_manufacturer": {
      "values": [
        "string"
      ],
      "operator": "in"
    },
    "product_status": {
      "values": [
        "active"
      ],
      "operator": "in"
    }
  }
}
```

--------------------------------

### Goflow API Response Sample (201 Created)

Source: https://goflow.com/api-spec/index

An example JSON response for a '201 Created' status code from the Goflow API, showing the structure with 'id' and 'location' fields.

```JSON
{
  "id": 0,
  "location": "string"
}
```

--------------------------------

### List Listings (GET)

Source: https://goflow.com/api-spec/index

Retrieves a list of listings with filtering and sorting capabilities. Rate limited to 60 requests per minute.

```APIDOC
## List listings • beta
get/v1/listings
/v1/listings
> This endpoint has a [rate limit](#section/Rate-Limits) of **60** requests per **minute**.

##### query Parameters
|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| filters | object  | Field | Operators | | --- | --- | | `store_provided_id` | `eq`, `not` | | `status` | `eq`, `not` | | `sku` | `eq`, `not` | | `store.id` | `eq`, `not` | | `product.id` | `eq`, `not`, `exists` | | `tags.id` | `eq`, `not` |   Refer to [the general filters section](#section/Filters) for details on how to use these filters. |
| sort | string  Enum: store_provided_id sku store.id product.id  The field by which to sort the results. |
| sort_direction | string  Enum: asc desc  The direction of the sort. |

### Responses
**200**
Success

##### Response Schema: application/json application/json text/json
|  |  |
| --- | --- |
| data | Array of objects[ items ] |
| next | string or null  A link to the next page of results. |

### Response samples
* 200
Content type
application/json
application/json
text/json
Copy
 Expand all  Collapse all
`{
* "data": [
  + {
    - "internal_id": "string",
    - "status": "in_review",
    - "store": {
      * "id": 0,
      * "name": "string",
      * "channel": "academy_sports"},
    - "store_provided_id": "string",
    - "store_page_url": "string",
    - "sku": "string",
    - "fulfillment_network_sku": "string",
    - "title": "string",
    - "description": "string",
    - "price": {
      * "amount": 0,
      * "currency": {
        + "code": "unknown"}},
    - "product": {
      * "id": 0,
      * "item_number": "string"},
    - "fulfilled_by": "merchant",
    - "tags": [
      * {
        + "id": "string",
        + "name": "string"}],
    - "notes": [
      * {
        + "created_at": "2019-08-24T14:15:22Z",
        + "updated_at": "2019-08-24T14:15:22Z",
        + "text": "string"}]}],
* "next": "string"
}`
```

--------------------------------

### Receipt Response Sample

Source: https://goflow.com/api-spec/index

Example JSON structure for a successful response (200 OK) when retrieving receipt details, showcasing various fields like reference number, status, warehouse, vendor, lines, tags, and metadata.

```json
{
  "id": 0,
  "reference_number": "string",
  "date": "2019-08-24T14:15:22Z",
  "status": "draft",
  "warehouse": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "vendor": {
    "id": 0,
    "name": "string"
  },
  "lines": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "product": {
        "id": 0,
        "item_number": "string",
        "name": "string"
      },
      "description": "string",
      "purchase_order": {
        "id": 0,
        "purchase_order_number": "string",
        "line_id": 0,
        "quantity": {
          "amount": 0,
          "measure": {
            "amount": 0,
            "abbreviation": "string"
          }
        }
      },
      "units_received": 0,
      "cost": {
        "amount": 0,
        "currency": {
          "code": "unknown",
          "exchange_rate": 0
        }
      },
      "children": [
        {
          "product": {
            "id": 0,
            "item_number": "string",
            "name": "string"
          },
          "description": "string",
          "units_received": 0
        }
      ]
    }
  ],
  "tags": [
    {
      "id": "string"
    }
  ],
  "notes": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "text": "string"
    }
  ],
  "meta": {
    "created": {
      "at": "2019-08-24T14:15:22Z",
      "by": {
        "type": "user",
        "user": {
          "username": "string"
        }
      }
    }
  }
}
```

--------------------------------

### Inventory Productions API (GET)

Source: https://goflow.com/api-spec/index

Provides endpoints for retrieving lists of inventory productions with filtering and sorting capabilities, as well as fetching details for a single production by its ID.

```APIDOC
## Inventory Productions API

### List Productions

**GET /v1/inventory/productions**

Retrieves a list of inventory productions with support for filtering and sorting.

*   **Query Parameters**:
    *   `filters` (object): Allows filtering results based on various fields.
        *   `id`: Operators `eq`, `not`
        *   `reference_number`: Operators `eq`, `not`
        *   `date`: Operators `gt`, `gte`, `lt`, `lte`
        *   `type`: Operators `eq`, `not`
        *   `status`: Operators `eq`, `not`
        *   `warehouse.id`: Operators `eq`, `not`
        *   `product.id`: Operators `eq`, `not`
        *   `tags.id`: Operators `eq`, `not`
        *   Refer to [the general filters section](#section/Filters) for details.
    *   `sort` (string): The field by which to sort the results. Enum: `id`, `reference_number`, `date`.
    *   `sort_direction` (string): The direction of the sort. Enum: `asc`, `desc`.

*   **Responses**:
    *   **200 Success**:
        *   Schema: `application/json`
        *   Body: `{
  "data": [
    {
      "id": 0,
      "reference_number": "string",
      "date": "2019-08-24T14:15:22Z",
      "type": "assembly",
      "status": "in_progress",
      "warehouse": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "quantity": {
        "amount": 0,
        "measure": {
          "amount": 0,
          "abbreviation": "string"
        }
      },
      "product": {
        "id": 0,
        "item_number": "string",
        "name": "string",
        "children": [
          {
            "id": 0,
            "item_number": "string",
            "name": "string",
            "units_per_parent": 0
          }
        ]
      },
      "fulfillments": [
        {
          "fulfilled_at": "2019-08-24T14:15:22Z",
          "units": 0
        }
      ],
      "is_reserving_inventory": true,
      "tags": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "notes": [
        {
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "text": "string"
        }
      ]
    }
  ],
  "next": "string or null"
}`

### Fetch Single Production

**GET /v1/inventory/productions/{id}**

Retrieves the details of a specific inventory production by its internal ID.

*   **Rate Limit**: 60 requests per minute.
*   **Path Parameters**:
    *   `id` (required, string): The internal ID for the production.

*   **Responses**:
    *   **200 Success**:
        *   Schema: `application/json`
        *   Body: `{
  "id": 0,
  "reference_number": "string",
  "date": "2019-08-24T14:15:22Z",
  "type": "assembly",
  "status": "in_progress",
  "warehouse": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "quantity": {
    "amount": 0,
    "measure": {
      "amount": 0,
      "abbreviation": "string"
    }
  },
  "product": {
    "id": 0,
    "item_number": "string",
    "name": "string",
    "children": [
      {
        "id": 0,
        "item_number": "string",
        "name": "string",
        "units_per_parent": 0
      }
    ]
  },
  "fulfillments": [
    {
      "fulfilled_at": "2019-08-24T14:15:22Z",
      "units": 0
    }
  ],
  "is_reserving_inventory": true,
  "tags": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "notes": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "text": "string"
    }
  ]
}`
```

--------------------------------

### Goflow Transfer Response Schema

Source: https://goflow.com/api-spec/index

Example JSON schema for a successful response (200 OK) when fetching a single Goflow transfer. It outlines the structure of the returned transfer object.

```JSON
{
  "id": 0,
  "location": "string"
}
```

--------------------------------

### Get Products Query Parameters and Response

Source: https://goflow.com/api-spec/index

Defines query parameters for filtering and sorting product lists, along with the structure of a successful 200 OK response. Supports filtering by ID, item number, status, and various details fields, with options for sorting and direction.

```APIDOC
API Endpoint: GET /products (Implied)

Query Parameters:
- filters (object): Allows filtering results based on various fields and operators.
  - id: Supported operators: eq, not
  - item_number: Supported operators: eq, not
  - status: Supported operators: eq, not
  - details.brand: Supported operators: eq, not
  - details.category: Supported operators: eq, not
  - details.condition: Supported operators: eq, not
  - details.manufacturer: Supported operators: eq, not
  - details.name: Supported operators: eq, not
  - details.is_perishable: Supported operators: eq, not
  - tags.id: Supported operators: eq, not
  (Refer to general filters section for detailed usage.)
- sort (string): The field by which to sort the results. Enum values include: id, item_number, details.brand, details.category, details.condition, etc.
- sort_direction (string): The direction of the sort. Enum values: asc, desc.

Responses:
- 200 OK (Success):
  Response Schema:
  {
    "data": [
      {
        "id": integer,
        "type": string,
        "item_number": string,
        "status": string,
        "tags": [
          {
            "id": string,
            "name": string
          }
        ],
        "children": [
          {
            "product_id": integer,
            "quantity": integer
          }
        ],
        "details": {
          "name": string,
          "description": string,
          "purchase_name": string,
          "brand": string,
          "manufacturer": string,
          "condition": string,
          "category": string,
          "is_perishable": boolean
        },
        "pricing": {
          "default_cost": integer,
          "default_price": integer,
          "msrp": integer,
          "map": integer
        },
        "settings": {
          "fulfillment_method": string,
          "is_purchasable": boolean,
          "is_sellable": boolean
        },
        "units_of_measure": {
          "defaults": {
            "purchasing": string,
            "sales": string,
            "shipping": string
          },
          "all": [
            {
              "id": string,
              "quantity": integer,
              "abbreviation": string,
              "description": string
            }
          ]
        },
        "identifiers": [
          {
            "type": string,
            "value": string,
            "unit_of_measure_id": string
          }
        ],
        "shipping": {
          "weight": {
            "measure": string,
            "amount": integer
          },
          "dimensions": {
            "measure": string,
            "length": integer,
            "width": integer,
            "height": integer
          },
          "insured_value": integer
        },
        "customs": {
          "description": string,
          "declared_value": integer,
          "hts_tariff_code": string,
          "country_of_origin": string
        }
      }
    ],
    "next": string or null
  }
}
```

--------------------------------

### Goflow API Request/Response Schema

Source: https://goflow.com/api-spec/index

Defines the structure for successful API responses and provides an example JSON payload for creating orders. The response schema includes an array of order objects, each with an ID and quantity. The request payload mirrors this structure.

```APIDOC
APIDOC:
  Description: Goflow API Request and Response Structures

  Response (200 OK):
    Description: Success response containing newly-created orders.
    Content-Type: application/json, text/json
    Schema:
      type: object
      properties:
        orders:
          type: array
          description: The newly-created individual orders.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the order line item.
              quantity:
                type: integer
                description: The quantity of the item in the order.

  Request Payload Example:
    Description: Example JSON payload for creating orders.
    Content-Type: application/json, application/*+json
    Payload:
      {
        "chunks": [
          {
            "lines": [
              {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "quantity": 1
              }
            ]
          },
          {
            "lines": [
              {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "quantity": 1
              }
            ]
          }
        ]
      }
```

--------------------------------

### Update Order Shipment Request Payload Example

Source: https://goflow.com/api-spec/index

An example JSON payload for updating an order's shipment details. This includes the shipment type, shipping method, and optional third-party account information with its address.

```json
{
  "shipment_type": "small_parcel",
  "shipping_method": "amazon_logistics_us_bulk",
  "scac": "string",
  "third_party_account": {
    "account_number": "string",
    "address": {
      "company": "string",
      "street1": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "country_code": "ad"
    }
  }
}
```

--------------------------------

### Create Product API Endpoint

Source: https://goflow.com/api-spec/index

Provides details for the POST /v1/products endpoint used to create new products. Includes request body schema with product details, pricing, settings, and identifiers, as well as the response schema for a successful creation (201 Created).

```APIDOC
API Endpoint: POST /v1/products

Rate Limit: 30 requests per minute.

Request Body Schema (application/json):
{
  "type": string (default: "standard", enum: ["standard", "group", "kit"]): The type of product.
  "item_number": string (required, 1-100 chars): The unique user-defined item number.
  "children": array of objects or null (max 25 items): List of child products and quantities for group/kit products.
  "details": object or null: General product details.
  "pricing": object or null: Pricing details.
  "settings": object or null: General settings.
  "units_of_measure": object or null: Product's units of measure.
  "identifiers": array of objects or null (max 25 items): List of product identifiers.
  "shipping": object or null: Product packing & shipping properties.
  "customs": object or null: Product customs & tariff properties.
}

Responses:
- 201 Created:
  Response Schema:
  {
    "id": integer (int64): The internal ID of the newly-created resource.
    "location": string: The URL to retrieve the resource.
  }
```

--------------------------------

### Products API Operations

Source: https://goflow.com/api-spec/index

Provides endpoints for managing product information, including listing, creating, fetching, updating pricing, and managing tags. Beta endpoints are marked.

```APIDOC
Products:
  - getList products • beta
    - Fetches a list of products.
  - postCreate product • beta
    - Creates a new product.
  - getFetch single product • beta
    - Fetches details for a single product.

Products • Pricing:
  - patchEdit pricing • beta
    - Edits pricing information for a product.

Products • Tags:
  - patchAdd tags
    - Adds tags to products.
  - putReplace tags
    - Replaces existing tags on products.
  - delRemove tags
    - Removes tags from products.
```

--------------------------------

### Product Catalog API

Source: https://goflow.com/api-spec/index

Provides an endpoint to list products in the catalog. Products can be of type 'standard', 'group', or 'kit', each with different inventory and cost behaviors. This is a beta feature.

```APIDOC
Products API:

  List products (beta):
    Method: GET
    Endpoint: /v1/products
    Rate Limit: 60 requests per minute
    Description: Retrieves a list of products from the catalog. Products can be of type 'standard', 'group', or 'kit'.
    - 'standard': Regular product with inventory and costs.
    - 'group': Virtual product grouping others; no own inventory/costs.
    - 'kit': Assembled/disassembled product; moves inventory/costs with children.
    Parameters:
      (No query parameters specified in the provided text)
    Responses:
      (Response schema not detailed in the provided text, but typically includes an array of product objects.)
```

--------------------------------

### Fetch Single Product API Endpoint

Source: https://goflow.com/api-spec/index

Retrieves detailed information for a specific product using its internal ID. This endpoint is beta and has a rate limit of 60 requests per minute. It returns a comprehensive product object.

```APIDOC
GET /v1/products/{id}

> This endpoint has a [rate limit](#section/Rate-Limits) of **60** requests per **minute**.

##### path Parameters

|  |  |
| --- | --- |
| id required | string  The internal ID for the product. |

### Responses

**200**

Success

##### Response Schema: application/json

|  |  |
| --- | --- |
| id | integer <int64>  The internal ID for the product. |
| type | string  Enum: standard group kit  The type of product.   * `standard`: a regular product. * `group`: A virtual product, which is a grouping of other products. Groups have no inventory of their own. * `kit`: A product that can be assembled/disassembled from/into other products.   See [the section description](#tag/Products) above for a detailed explanation. |
| item_number | string  The user-defined item number, displayed everywhere in the app.  **Note**: Item numbers never change. |
| status | string  Enum: active inactive  The current status of the product. |
| tags | Array of objects[ items ]  A list of user-defined tags assigned to this product. |
| children | Array of objects[ items ]  A list of child products and quantities that make up the "recipe" for this product.  **Note**: Only applies to `group` and `kit` products. See [the section description](#tag/Products) above for a detailed explanation. |
| details | object  General details about the product. |
| pricing | object  Pricing details for the product. |
| settings | object  General settings for the product. |
| units_of_measure | object  The product's units of measure. |
| identifiers | Array of objects[ items ]  A list of identifiers (usually printed on barcodes) for this product. |
| shipping | object  The product's packing & shipping properties. |
| customs | object  The product's customs & tariff properties. |
```

--------------------------------

### Create Box Request Schema and Sample

Source: https://goflow.com/api-spec/index

Defines the structure for creating a new box within an order shipment. Includes fields for cost, tracking number, SSCC, weight, dimensions, and packed product lines. A sample payload is provided.

```APIDOC
POST /v1/orders/{id}/shipment/boxes

Request Body Schema:
application/json

| Field | Type | Description |
|---|---|---|
| cost | object or null | The shipping cost for this box. |
| tracking_number | string or null | The tracking number or, for LTL orders, the PRO number. |
| sscc | string or null | The "Serial Shipping Container Code" for this box. Must be 20 digits. |
| weight | object or null | The weight of this box. |
| dimensions | object or null | The dimensions of this box. |
| lines | Array of objects | The products packed in this box. For group products, only list the group's children. |

Request Sample:
```json
{
  "cost": {
    "amount": 0.01
  },
  "tracking_number": "string",
  "sscc": "string",
  "weight": {
    "measure": "pounds",
    "amount": 0.001
  },
  "dimensions": {
    "measure": "inches",
    "length": 0.001,
    "width": 0.001,
    "height": 0.001
  },
  "lines": [
    {
      "order_line_id": "bc9d0c12-1a56-474d-bb91-af19b2f06cc4",
      "quantity": 0
    }
  ]
}
```

Response Schema (200 OK):
application/json

| Field | Type | Description |
|---|---|---|
| box_id | string <uuid> | The ID of the newly-created box. |

Response Sample (200 OK):
```json
{
  "box_id": "cc04d3e6-0274-4602-af5c-c924910fec95"
}
```
```

--------------------------------

### Fetch Single Transfer API

Source: https://goflow.com/api-spec/index

Details the GET /v1/transfers/{id} endpoint for retrieving a specific transfer. Includes path parameters, rate limits, and a comprehensive response schema.

```APIDOC
GET /v1/transfers/{id}

This endpoint retrieves a single transfer by its internal ID.

Rate Limit: 60 requests per minute.

Path Parameters:
  id (required, string): The internal ID for the transfer.

Responses:
  200 OK:
    Description: Success
    Content Type: application/json
    Schema:
      id (integer): The internal ID for the transfer.
      reference_number (string or null): The user-provided reference number for the transfer.
      external_id (string or null): The external ID for the transfer.
      date (string, date-time): The date on the transfer, typically creation date but can be modified.
      status (string): The current status of the transfer (e.g., ready_to_pick, ready_to_pack).
      warehouses (object): Information about the warehouses involved.
      lines (Array of objects): A list of line items with product details.
      shipment (object or null): Information about the transfer's shipment.
      is_reserving_inventory (boolean or null): Indicates if inventory is reserved in the 'from' warehouse.
      tags (Array of objects): A list of tags assigned to the transfer.
      notes (Array of objects): A list of notes.
      meta (object): Meta information about the transfer.
```

--------------------------------

### Goflow Transfer Request Payload

Source: https://goflow.com/api-spec/index

Example JSON payload structure for a Goflow transfer request. It includes details about the transfer, such as reference number, date, warehouses, lines, inventory reservation, and tags.

```JSON
{
  "transfer": {
    "reference_number": "string",
    "date": "2019-08-24T14:15:22Z",
    "warehouses": {
      "from": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "address": {
          "street1": "string",
          "street2": "string",
          "city": "string",
          "state": "string",
          "zip_code": "string",
          "country_code": "ad",
          "email": "user@example.com",
          "phone": "string",
          "phone_extension": "string",
          "company": "string"
        }
      },
      "to": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    },
    "lines": [
      {
        "product": {
          "id": 0
        },
        "listing": {
          "sku": "string"
        },
        "quantity": {
          "amount": 1
        }
      }
    ],
    "is_reserving_inventory": true,
    "tags": [
      {
        "id": "string"
      }
    ]
  },
  "options": {
    "save_as": "open"
  }
}
```

--------------------------------

### List Vendor Products API

Source: https://goflow.com/api-spec/index

Retrieves a list of vendor products with filtering and sorting capabilities. Supports pagination via the 'next' link in the response. Rate limit is 60 requests per minute.

```APIDOC
GET /v1/vendor-products

> Rate limit: 60 requests per minute.

Query Parameters:
- filters (object): For filtering results. Supports operators like `eq`, `not`, `gt`, `gte`, `lt`, `lte`, `exists` on fields such as `vendor_item_number`, `vendor.id`, `product.id`, `inventory.expires_at`, `updated_at`, `tags.id`. Refer to general filters section for details.
- sort (string): The field by which to sort the results. Enum: `vendor_item_number`, `vendor.id`, `product.id`, `inventory.expires_at`, `updated_at`.
- sort_direction (string): The direction of the sort. Enum: `asc`, `desc`.

Responses:
- 200 Success:
  - Schema: {
    "data": Array of objects [
      {
        "vendor_item_number": "string",
        "vendor": {
          "id": 0,
          "name": "string"
        },
        "product": {
          "id": 0,
          "item_number": "string"
        },
        "inventory": {
          "quantity": 0,
          "expires_at": "2019-08-24T14:15:22Z"
        },
        "cost": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "tags": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      }
    ],
    "next": "string or null"
  }
  - Sample: {
    "data": [
      {
        "vendor_item_number": "string",
        "vendor": {
          "id": 0,
          "name": "string"
        },
        "product": {
          "id": 0,
          "item_number": "string"
        },
        "inventory": {
          "quantity": 0,
          "expires_at": "2019-08-24T14:15:22Z"
        },
        "cost": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "tags": [
          {
            "id": "string",
            "name": "string"
          }
        ]
      }
    ],
    "next": "string"
  }
```

--------------------------------

### Get Order Document URLs

Source: https://goflow.com/api-spec/index

Retrieves publicly-accessible URLs for specific order documents. These URLs are valid for a limited time and do not require authentication. The endpoint has a rate limit of 60 requests per minute.

```APIDOC
GET /v1/orders/{id}/documents

Path Parameters:
  id (string, required): The internal ID for the order.

Responses:
  200 OK:
    Content-Type: application/json
    Schema:
      bill_of_lading: object or null (URL, format, url_expires_at)
      carton_labels: object or null (all: {URL, format, url_expires_at}, singles: [Array of {URL, format, url_expires_at}])
      commercial_invoice: object or null (URL, format, url_expires_at)
      packing_slips: Array of objects (URL, format, url_expires_at, source)
      pallet_labels: object or null (all: {URL, format, url_expires_at}, singles: [Array of {URL, format, url_expires_at}])
      shipping_labels: object or null (all: {URL, format, url_expires_at}, singles: [Array of {URL, format, url_expires_at}])

Example Response (200):
{
  "bill_of_lading": {
    "url": "string",
    "format": "pdf",
    "url_expires_at": "2019-08-24T14:15:22Z"
  },
  "carton_labels": {
    "all": {
      "url": "string",
      "format": "pdf",
      "url_expires_at": "2019-08-24T14:15:22Z"
    },
    "singles": [
      {
        "url": "string",
        "format": "pdf",
        "url_expires_at": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "commercial_invoice": {
    "url": "string",
    "format": "pdf",
    "url_expires_at": "2019-08-24T14:15:22Z"
  },
  "packing_slips": [
    {
      "url": "string",
      "format": "pdf",
      "url_expires_at": "2019-08-24T14:15:22Z",
      "source": "channel"
    }
  ],
  "pallet_labels": {
    "all": {
      "url": "string",
      "format": "pdf",
      "url_expires_at": "2019-08-24T14:15:22Z"
    },
    "singles": [
      {
        "url": "string",
        "format": "pdf",
        "url_expires_at": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "shipping_labels": {
    "all": {
      "url": "string",
      "format": "pdf",
      "url_expires_at": "2019-08-24T14:15:22Z"
    },
    "singles": [
      {
        "url": "string",
        "format": "pdf",
        "url_expires_at": "2019-08-24T14:15:22Z"
      }
    ]
  }
}
```

--------------------------------

### Fetch Single Order API

Source: https://goflow.com/api-spec/index

Retrieves a single order by its internal ID. This endpoint has a rate limit of 60 requests per minute. It details path parameters and provides example request and response payloads.

```APIDOC
GET /v1/orders/{id}

> Rate Limit: 60 requests per minute.

##### Path Parameters

| Name | Required | Type   | Description                     |
| ---- | -------- | ------ | ------------------------------- |
| id   | yes      | string | The internal ID for the order. |

##### Request Body Example (application/json)

```json
{
  "order": {
    "order_number": "string",
    "date": "2019-08-24T14:15:22Z",
    "store": {
      "id": 0
    },
    "warehouse": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "currency": {
      "code": "afn",
      "exchange_rate": 0
    },
    "lines": [
      {
        "product": {
          "id": 0
        },
        "listing": {
          "sku": "string"
        },
        "quantity": {
          "amount": 1,
          "measure": {
            "abbreviation": "string"
          }
        },
        "charges": [
          {
            "type": "price",
            "amount": -10000000
          }
        ],
        "taxes": [
          {
            "type": "price",
            "amount": 10000000
          }
        ],
        "costs": [
          {
            "type": "commission",
            "amount": 10000000
          }
        ],
        "consumer_financials": [
          {
            "type": "price",
            "amount": -10000000
          }
        ],
        "customization": {
          "text": "string",
          "data": [
            {
              "group": "string",
              "key": "string",
              "value": "string"
            }
          ]
        }
      }
    ],
    "billing_address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "country_code": "ad",
      "email": "user@example.com",
      "phone": "string",
      "phone_extension": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string"
    },
    "shipping_address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "country_code": "ad",
      "email": "user@example.com",
      "phone": "string",
      "phone_extension": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string"
    },
    "purchase_order_number": "string",
    "is_gift": false,
    "is_reserving_inventory": true,
    "shipment": {
      "type": "small_parcel",
      "shipping_method": "amazon_logistics_us_bulk",
      "scac": "string",
      "third_party_account": {
        "account_number": "string",
        "address": {
          "company": "string",
          "street1": "string",
          "city": "string",
          "state": "string",
          "zip_code": "string",
          "country_code": "ad"
        }
      }
    },
    "ship_dates": {
      "earliest_ship": "2019-08-24T14:15:22Z",
      "latest_ship": "2019-08-24T14:15:22Z",
      "earliest_delivery": "2019-08-24T14:15:22Z",
      "latest_delivery": "2019-08-24T14:15:22Z"
    },
    "tags": [
      {
        "id": "string"
      }
    ],
    "charges": [
      {
        "type": "discount",
        "amount": -10000000
      }
    ],
    "taxes": [
      {
        "type": "price",
        "amount": 10000000
      }
    ],
    "costs": [
      {
        "type": "payment_fee",
        "amount": 10000000
      }
    ]
  },
  "options": {
    "ship_service_level": "in_1_day"
  }
}
```

##### Response Body Example (200 OK - application/json)

```json
{
  "id": 0,
  "location": "string"
}
```
```
Tokens:
Raw