# Retrieve Retrieve all orders created by OpenAPI calls. This endpoint does not return orders created on-platform. Endpoint: GET /v1/order Version: 1.0.0 Security: apikey ## Query parameters: - `OrderIds` (array) Filter orders by a list of order IDs separated by comma. - `OrderStatus` (string) Filter orders by status (e.g., 'Draft', 'Mailed'). - `Paid` (boolean) Filter orders by whether they are paid or not. - `ProductType` (string) Filter orders by product type. - `PostageType` (string) Filter orders by postage type. - `ShowRecipients` (boolean) Filter whether to return recipient information. - `Skip` (integer) Used for pagination, the number of records to skip. Defaults to 0. - `Take` (integer) Used for pagination, the number of records to retrieve. Defaults to 100. ## Response 400 fields (application/json): - `payload` (object) - `payload.orders` (array) - `payload.orders.id` (integer) - `payload.orders.status` (string) - `payload.orders.paidDate` (string,null) - `payload.orders.mailedDate` (string,null) - `payload.orders.holdUntilDate` (string,null) - `payload.orders.postageType` (string) - `payload.orders.productType` (string) - `payload.orders.productionSpeed` (string) - `payload.orders.handwrittenFont` (string) - `payload.orders.qrCodeUrl` (string) - `payload.orders.deliveredStatus` (object) - `payload.orders.deliveredStatus.mailed` (number,null) - `payload.orders.deliveredStatus.inTransit` (number,null) - `payload.orders.deliveredStatus.atLocalFacility` (number,null) - `payload.orders.deliveredStatus.delivered` (number,null) - `payload.orders.recipients` (array) - `payload.orders.recipients.orderId` (integer,null) - `payload.orders.recipients.firstName` (string) - `payload.orders.recipients.lastName` (string) - `payload.orders.recipients.salutation` (string) - `payload.orders.recipients.toOrganization` (string) - `payload.orders.recipients.address1` (string) - `payload.orders.recipients.address2` (string) - `payload.orders.recipients.city` (string) - `payload.orders.recipients.state` (string) - `payload.orders.recipients.zipCode` (string) - `payload.orders.recipients.phoneNumber` (string) - `payload.orders.recipients.email` (string) - `payload.orders.recipients.country` (string) - `payload.orders.recipients.custom1` (string) - `payload.orders.recipients.custom2` (string) - `payload.orders.recipients.custom3` (string) - `payload.orders.recipients.custom4` (string) - `payload.orders.recipients.custom5` (string) - `payload.orders.recipients.custom6` (string) - `payload.orders.recipients.image1` (string) - `payload.orders.recipients.image2` (string) - `payload.orders.recipients.image3` (string) - `payload.orders.recipients.image4` (string) - `payload.orders.recipients.image5` (string) - `payload.orders.recipients.image6` (string) - `payload.orders.recipients.delivery` (object) - `payload.orders.recipients.delivery.updatedDate` (string,null) - `errors` (array) - `warnings` (array) - `hasErrors` (boolean) - `hasWarnings` (boolean) ## Response 401 fields (application/json): - `payload` (object) - `payload.orders` (array) - `payload.orders.id` (integer) - `payload.orders.status` (string) - `payload.orders.paidDate` (string,null) - `payload.orders.mailedDate` (string,null) - `payload.orders.holdUntilDate` (string,null) - `payload.orders.postageType` (string) - `payload.orders.productType` (string) - `payload.orders.productionSpeed` (string) - `payload.orders.handwrittenFont` (string) - `payload.orders.qrCodeUrl` (string) - `payload.orders.deliveredStatus` (object) - `payload.orders.deliveredStatus.mailed` (number,null) - `payload.orders.deliveredStatus.inTransit` (number,null) - `payload.orders.deliveredStatus.atLocalFacility` (number,null) - `payload.orders.deliveredStatus.delivered` (number,null) - `payload.orders.recipients` (array) - `payload.orders.recipients.orderId` (integer,null) - `payload.orders.recipients.firstName` (string) - `payload.orders.recipients.lastName` (string) - `payload.orders.recipients.salutation` (string) - `payload.orders.recipients.toOrganization` (string) - `payload.orders.recipients.address1` (string) - `payload.orders.recipients.address2` (string) - `payload.orders.recipients.city` (string) - `payload.orders.recipients.state` (string) - `payload.orders.recipients.zipCode` (string) - `payload.orders.recipients.phoneNumber` (string) - `payload.orders.recipients.email` (string) - `payload.orders.recipients.country` (string) - `payload.orders.recipients.custom1` (string) - `payload.orders.recipients.custom2` (string) - `payload.orders.recipients.custom3` (string) - `payload.orders.recipients.custom4` (string) - `payload.orders.recipients.custom5` (string) - `payload.orders.recipients.custom6` (string) - `payload.orders.recipients.image1` (string) - `payload.orders.recipients.image2` (string) - `payload.orders.recipients.image3` (string) - `payload.orders.recipients.image4` (string) - `payload.orders.recipients.image5` (string) - `payload.orders.recipients.image6` (string) - `payload.orders.recipients.delivery` (object) - `payload.orders.recipients.delivery.updatedDate` (string,null) - `errors` (array) - `warnings` (array) - `hasErrors` (boolean) - `hasWarnings` (boolean) ## Response 403 fields (application/json): - `payload` (object) - `payload.orders` (array) - `payload.orders.id` (integer) - `payload.orders.status` (string) - `payload.orders.paidDate` (string,null) - `payload.orders.mailedDate` (string,null) - `payload.orders.holdUntilDate` (string,null) - `payload.orders.postageType` (string) - `payload.orders.productType` (string) - `payload.orders.productionSpeed` (string) - `payload.orders.handwrittenFont` (string) - `payload.orders.qrCodeUrl` (string) - `payload.orders.deliveredStatus` (object) - `payload.orders.deliveredStatus.mailed` (number,null) - `payload.orders.deliveredStatus.inTransit` (number,null) - `payload.orders.deliveredStatus.atLocalFacility` (number,null) - `payload.orders.deliveredStatus.delivered` (number,null) - `payload.orders.recipients` (array) - `payload.orders.recipients.orderId` (integer,null) - `payload.orders.recipients.firstName` (string) - `payload.orders.recipients.lastName` (string) - `payload.orders.recipients.salutation` (string) - `payload.orders.recipients.toOrganization` (string) - `payload.orders.recipients.address1` (string) - `payload.orders.recipients.address2` (string) - `payload.orders.recipients.city` (string) - `payload.orders.recipients.state` (string) - `payload.orders.recipients.zipCode` (string) - `payload.orders.recipients.phoneNumber` (string) - `payload.orders.recipients.email` (string) - `payload.orders.recipients.country` (string) - `payload.orders.recipients.custom1` (string) - `payload.orders.recipients.custom2` (string) - `payload.orders.recipients.custom3` (string) - `payload.orders.recipients.custom4` (string) - `payload.orders.recipients.custom5` (string) - `payload.orders.recipients.custom6` (string) - `payload.orders.recipients.image1` (string) - `payload.orders.recipients.image2` (string) - `payload.orders.recipients.image3` (string) - `payload.orders.recipients.image4` (string) - `payload.orders.recipients.image5` (string) - `payload.orders.recipients.image6` (string) - `payload.orders.recipients.delivery` (object) - `payload.orders.recipients.delivery.updatedDate` (string,null) - `errors` (array) - `warnings` (array) - `hasErrors` (boolean) - `hasWarnings` (boolean)