Export

GET

/shipping_integrations/orders/export/v1

GET

/shipping_integrations/orders/export/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shippingIntegrations.orders.exportV1({
        filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
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
}

Exports all the caller’s integration orders within an inclusive completion timestamp range, newest completions first, without pagination. | () -> (ShippingIntegrationOrderListRes)

Authentication

AuthorizationBearer

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

Query parameters

filter_completed_at_timestamp_gtedatetimeRequired

Include orders completed at or after this timestamp.

filter_completed_at_timestamp_ltedatetimeRequired

Include orders completed at or before this timestamp.

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders Export V1request Unprocessable Entity Error