List for integration executor

GET

/shipping_integrations/orders/list/for_integration_executor_operators/v1

GET

/shipping_integrations/orders/list/for_integration_executor_operators/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shippingIntegrations.orders.listForIntegrationExecutorOperatorsV1({
        filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_integration_order_id: "filter_integration_order_id",
        filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_reference_number: "filter_reference_number",
        filter_shipping_integration: [
            "xcelerator",
        ],
        filter_shipping_integration_order_ids: [
            "filter_shipping_integration_order_ids",
        ],
        filter_status: [
            "staged",
        ],
        page: 1,
        page_size: 1,
        search: "search",
        sort_by: "ordered_at_timestamp",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "first_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
      "integration_order_id": "integration_order_id",
      "last_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
      "org_id": "org_id",
      "provider_org_id": "provider_org_id",
      "schema_version": 1,
      "shipping_integration": "xcelerator",
      "source_provider_payload_hash": "source_provider_payload_hash",
      "status": "staged",
      "completed_at_provenance": "reported",
      "completed_at_timestamp": "2024-01-15T09:30:00Z",
      "destination": {
        "label": "label"
      },
      "in_progress_at_provenance": "reported",
      "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
      "ordered_at_timestamp": "2024-01-15T09:30:00Z",
      "origin": {
        "label": "label"
      },
      "provider_org": {
        "_id": "_id",
        "name": "name",
        "org_id": "org_id",
        "org_type": "provider",
        "schema_version": 1
      },
      "provider_status_raw": "provider_status_raw",
      "reference_numbers": [
        "reference_numbers"
      ],
      "shipper_org": {
        "_id": "_id",
        "name": "name",
        "org_id": "org_id",
        "org_type": "provider",
        "schema_version": 1
      },
      "stop_count": 1
    }
  ],
  "total_count": 1
}

Lists orders assigned to the caller’s integration executor organization across all shipping integrations with integration coordinator organizations expanded, filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ShippingIntegrationOrderListRes)

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

searchstringOptional

Search provider order IDs and reference numbers.

filter_shipping_integration_order_idsstringOptional

Filter by selected shipping integration order ids

filter_shipping_integrationenumOptional

Filter by shipping integration(s)

filter_statusenumOptional

Filter by unified status(es)

Allowed values:

filter_integration_order_idstringOptional

Filter by the provider's exact order ID

filter_reference_numberstringOptional

Filter by an exact reference number carried on the order

filter_ordered_at_timestamp_gtedatetimeOptional

Filter ordered_at_timestamp >= value

filter_ordered_at_timestamp_ltedatetimeOptional

Filter ordered_at_timestamp <= value

filter_last_mirrored_at_timestamp_gtedatetimeOptional

Filter last_mirrored_at_timestamp >= value

filter_last_mirrored_at_timestamp_ltedatetimeOptional

Filter last_mirrored_at_timestamp <= value

filter_first_mirrored_at_timestamp_gtedatetimeOptional

Filter first_mirrored_at_timestamp >= value

filter_first_mirrored_at_timestamp_ltedatetimeOptional

Filter first_mirrored_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List for Integration Executor Operators V1request Unprocessable Entity Error