Get by order

1 import { ChrtClient } from "@chrt-inc/typescript-sdk"; 2 3 const client = new ChrtClient({ token: "YOUR_TOKEN" }); 4 await client.shipperPayCourierPayments.getByOrderIdOrShortIdV1("order_id_or_short_id");

1 { 2 "schema_version": 1, 3 "shipper_pay_courier_line_item_group_ids": [ 4 "string" 5 ], 6 "task_group_ids": [ 7 "string" 8 ], 9 "courier_org_id": "string", 10 "payment_amount": 1.1, 11 "_id": "string", 12 "off_chrt_shipper_org_info_id": "string", 13 "shipper_org_id": "string", 14 "stripe_connect_shipper_pay_courier_customer_id": "string", 15 "stripe_invoice_id": "string", 16 "stripe_invoice_url": "string", 17 "stripe_invoice_created_timestamp": "2024-01-15T09:30:00Z", 18 "stripe_invoice_created_by_user_id": "string", 19 "stripe_invoice_status": "invoice_not_yet_created", 20 "stripe_invoice_completed_timestamp": "2024-01-15T09:30:00Z" 21 }

Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.

Authentication

AuthorizationBearer

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

Path Parameters

order_id_or_short_idstringRequired

Response

Successful Response

schema_versioninteger

shipper_pay_courier_line_item_group_idslist of strings

task_group_idslist of strings

courier_org_idstring

Must be a string starting with org_

payment_amountdouble

_idstring

off_chrt_shipper_org_info_idstring or null

shipper_org_idstring or null

stripe_connect_shipper_pay_courier_customer_idstring or null

stripe_invoice_idstring or null

stripe_invoice_urlstring or null

stripe_invoice_created_timestampstring or nullformat: "date-time"

stripe_invoice_created_by_user_idstring or null

stripe_invoice_statusenum or null

stripe_invoice_completed_timestampstring or nullformat: "date-time"

Authentication

Path Parameters

Response

Errors