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

productionStatuses

array of enums

Filter by the production status of the order.
Possible enum values
Canceled
The order was canceled.
Ignored
The order was ignored in Artelo and will not be processed.
Pending Swap Request
The order has a swap request awaiting approval.
Received
The order is received and is waiting to be sent to production, allowing for cancellations before production begins.
Customer Unpaid
The order has been received by Artelo but is not yet paid for in the connected integration.
Needs Address Review
The order's shipping address needs review before it can be sent to production.
Missing Designs
The order is waiting for designs to be added before it can be sent to production.
Show more values

shippingStatuses

array of enums

Filter by the shipping status of the order.
Possible enum values
Canceled
The order was canceled.
Shipping Pending
The shipping label for the order hasn't been created yet.
Shipping Purchased
The shipping label for the order has been purchased but the order has not yet been shipped.
Shipped
The order has been shipped and is on its way to the customer.
In Transit
The carrier has the order and it is on its way to the customer.
Shipment Error
The carrier encountered an issue while shipping the order.
Delivery Issue
The carrier encountered an issue while delivering the order.
Show more values

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.
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.
ImagesProcessing
The order's design images are still being processed.
Show more values
Returns
The Order objects matching the supplied filters.

GET

/orders/get

curl -G 'https://www.artelo.com/api/open/orders/get?limit=10' \
  -H 'Authorization: Bearer your-token'
Response
[
  {
    "channelName": null,
    "createdAt": "2024-09-30T13:56:29.057Z",
    "companyName": null,
    "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",
      "tin": "",
      "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,
        "productionStatus": "Packaging",
        "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
      }
    ],
    "productionStatus": "Packaging",
    "shipments": [
      {
        "carrierCode": "UPS",
        "trackingNumber": "1234567890",
        "trackingUrl": "http://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&AgreeToTermsAndConditions=yes&loc=en_US&tracknum=1234567890"
      }
    ],
    "shippingStatus": "Shipped",
    "status": "Shipped",
    "stickerPlacement": "PerUnit",
    "stickerId": "e7e38b9-442c-41bc-a849-32929a879537"
  }
]