Logo
Logo
⌘K

Get Orders

Fetch orders created by the API integration.
Parameters

allOrders

boolean

Whether or not to query all orders or only orders created by the API integration.

limit

number

Required

Number of results to return in each paginated query.

maxDate

string

Filter by the maximum created date of orders.

minDate

string

Filter by the minimum created date of orders.

name

string

Filter by name or orderId of the order.

offset

number

Offset for pagination.

sortDirection

enum

Sort direction for orders based on createdAt date. Defaults to descending.
Possible enum values
asc
desc

statuses

array of enums

Filter by the statuses of the order.
Possible enum values
PendingFulfillmentAction
The order requires user action before it can be sent to production.
AwaitingPayment
The order has been received by Artelo but is not yet paid for in the connected integration.
Received
The order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
InProduction
The production facility is currently processing the order.
Shipped
The order has been shipped.
Delivered
The order has been delivered.
Canceled
The order was canceled.
Show more values
Returns
The Order objects matching the supplied filters.

GET

/orders/get

curl -G 'https://www.artelo.io/api/open/orders/get?limit=10' \
  -H 'Authorization: Bearer your-token'
Response
[
  {
    "channelName": null,
    "createdAt": "2024-09-30T13:56:29.057Z",
    "companyName": null,
    "currency": "USD",
    "customerAddress": {
      "company": "Acme Inc.",
      "city": "Miami",
      "countryCode": "US",
      "id": "address-id",
      "name": "John Doe",
      "phone": "+15551234567",
      "state": "Florida",
      "street1": "No 1 Rosbridge Street",
      "street2": "#123",
      "email": "john@doe.com",
      "zipcode": "900110"
    },
    "details": {
      "amountRefunded": 0,
      "arteloShipping": 10,
      "branding": 1,
      "wholesaleDiscount": 0,
      "gst": 1,
      "hst": 1,
      "productionCost": 5,
      "pst": 1,
      "usSalesTax": 0
    },
    "id": "de14efbe-daec-4e2d-b967-80ca9a5f9c17",
    "insertPlacement": "PerOrder",
    "insertId": "b1e38b9-442c-41bc-a849-32929a879537",
    "instructions": "Handle it with care",
    "orderId": "this-is-the-order",
    "orderItems": [
      {
        "arteloProductId": "ee7e38b9-442c-41bc-a849-32929a879537",
        "orderItemId": "item-001",
        "isPersonalizable": false,
        "details": {
          "amountRefunded": 0,
          "arteloShipping": 10,
          "branding": 1,
          "wholesaleDiscount": 0,
          "gst": 1,
          "hst": 1,
          "productionCost": 5,
          "pst": 1,
          "usSalesTax": 0
        },
        "product": {
          "catalogProductId": "IndividualArtPrint",
          "frameColor": "BlackMetal",
          "frameStyle": "Metal",
          "includeFramingService": true,
          "includeHangingPins": true,
          "includeMats": true,
          "orientation": "Horizontal",
          "paperStyle": "FineArt",
          "paperType": "ArchivalMatteFineArt",
          "size": "x10x10"
        },
        "quantity": 10
      }
    ],
    "shipments": [
      {
        "carrierCode": "UPS",
        "trackingNumber": "1234567890",
        "trackingUrl": "http://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&AgreeToTermsAndConditions=yes&loc=en_US&tracknum=1234567890"
      }
    ],
    "status": "Shipped",
    "stickerPlacement": "PerUnit",
    "stickerId": "e7e38b9-442c-41bc-a849-32929a879537"
  }
]