---
updatedAt: 2026-09-24T22:59:05.000Z
agentTools:
  projectIndex: https://developers.getbyrd.com/llms.txt
---

# Export shipments as CSV

Returns a CSV file with one row per item of your shipments whose
`range_type` date falls between `start_date` and `end_date`. Use
your own user ID in the path.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "The byrd APIs for managing products, inbound deliveries, shipments and returns.",
    "contact": {
      "email": "info@getbyrd.com",
      "name": "General company contact",
      "url": "https://getbyrd.com/kontakt/"
    },
    "license": {
      "name": "Copyright byrd technologies GmbH"
    },
    "termsOfService": "https://getbyrd.com/agb/",
    "version": "20260924",
    "title": "byrd APIs"
  },
  "servers": [
    {
      "description": "Production server",
      "url": "https://api.getbyrd.com/"
    }
  ],
  "security": [
    {
      "tokenAuth": []
    }
  ],
  "paths": {
    "/v2/export/user/{user_id}/shipments": {
      "get": {
        "operationId": "shipmentexportapi_get",
        "responses": {
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "403": {
            "$ref": "#/components/responses/Error"
          },
          "default": {
            "$ref": "#/components/responses/Undefined"
          }
        },
        "tags": [
          "Account"
        ],
        "description": "Returns a CSV file with one row per item of your shipments whose\n`range_type` date falls between `start_date` and `end_date`. Use\nyour own user ID in the path.",
        "x-byrd-roles": [
          "admin",
          "customer",
          "operator",
          "customer_support",
          "service"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "start_date",
            "description": "First day of the export period (YYYY-MM-DD, inclusive). Defaults to 30 days before `end_date`. The period can be at most 365 days.",
            "schema": {
              "type": "string",
              "format": "date"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "end_date",
            "description": "Last day of the export period (YYYY-MM-DD, inclusive). Defaults to today and cannot be in the future.",
            "schema": {
              "type": "string",
              "format": "date"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "range_type",
            "description": "Shipment date that `start_date` and `end_date` apply to. Defaults to `created-date`.\n\n- `created-date`: when the shipment was created\n- `packaged-date`: when the shipment was packed\n- `shipped-date`: when the shipment was sent\n- `returned-date`: when the shipment was returned",
            "schema": {
              "type": "string",
              "default": "created-date",
              "enum": [
                "returned-date",
                "shipped-date",
                "packaged-date",
                "created-date"
              ]
            },
            "required": false
          },
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "ID of your byrd account (UUID); any other account answers `404`."
          }
        ],
        "summary": "Export shipments as CSV"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "tokenAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Authorization with previously obtained JSON Web Token"
      }
    },
    "responses": {
      "Undefined": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UndefinedResponse"
            }
          }
        },
        "description": "Generic success response"
      },
      "Error": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "Generic error response"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message",
          "errors"
        ],
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "Authentication.AuthenticationRequired",
              "Authentication.ExpiredJWTToken",
              "Authentication.InvalidCredentials",
              "Authentication.InvalidJWTToken",
              "Authentication.LocalityRequired",
              "Authentication.MissingPermission",
              "Authentication.ReadOnly",
              "Authentication.RoleNotAllowed",
              "Authentication.UserLocked",
              "Exception.404",
              "Exception.500",
              "Request.InvalidPagination",
              "Request.InvalidQuery",
              "Request.InvalidSchema",
              "Request.NoInput",
              "Request.ResourceNotFound"
            ]
          },
          "message": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Embedded instance of Error"
            }
          }
        },
        "title": "Error"
      },
      "UndefinedResponse": {
        "type": "object",
        "description": "Generic (expected) response when endpoint doesn't explicitly define one",
        "properties": {
          "data": {
            "type": "object"
          }
        },
        "title": "Undefined response"
      }
    }
  },
  "tags": [
    {
      "name": "Account",
      "description": "The warehouses and B2B templates available to your account, and CSV exports of your shipments, returns and inventory."
    }
  ],
  "x-readme": {
    "apply-tag-changes": true,
    "apply-endpoint-order": true
  }
}
```