List

GET

/shipping_integrations/courie/orders/list/v1

GET

/shipping_integrations/courie/orders/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shippingIntegrations.courie.orders.listV1({
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_customer_id: "filter_customer_id",
        filter_integration_order_id: "filter_integration_order_id",
        filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_provider_org_id: [
            "filter_provider_org_id",
        ],
        filter_provider_status: "CREATED",
        filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
        page: 1,
        page_size: 1,
        sort_by: "mirrored_at_timestamp",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "integration_order_id": "integration_order_id",
      "mirrored_at_timestamp": "2024-01-15T09:30:00Z",
      "org_id": "org_id",
      "provider_org_id": "provider_org_id",
      "provider_payload": {
        "customerId": "customerId",
        "id": "id",
        "status": "CREATED"
      },
      "provider_payload_hash": "provider_payload_hash",
      "schema_version": 1,
      "shipping_integration": "courie",
      "updated_at_timestamp": "2024-01-15T09:30:00Z"
    }
  ],
  "total_count": 1
}

Lists mirrored Courie orders for the caller’s organization with filtering, sorting, and pagination. | () -> (CourieOrderListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_provider_org_idstringOptional

Filter by provider org ID(s)

filter_integration_order_idstringOptional

Filter by Courie's exact order ID

filter_customer_idstringOptional

Filter by the Courie customer the order belongs to

filter_provider_statusenumOptional

Filter by Courie's own order status

filter_mirrored_at_timestamp_gtedatetimeOptional

Filter mirrored_at_timestamp >= value

filter_mirrored_at_timestamp_ltedatetimeOptional

Filter mirrored_at_timestamp <= value

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value

filter_updated_at_timestamp_gtedatetimeOptional

Filter updated_at_timestamp >= value

filter_updated_at_timestamp_ltedatetimeOptional

Filter updated_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List V1request Unprocessable Entity Error