BillingCharges
Get Many Charge
Get a list of charges with filtering and pagination
Authorization
api_key x-access-token<token>
In: header
Query Parameters
search?string
Search charges by id, name, or description
Default
""category?string
Filter charges by category (comma-separated for multiple values)
Default
""rate_period?string
Filter charges by rate period (comma-separated for multiple values)
Default
""unallocated?boolean
Filter charges by whether they are allocated to an invoice
order_id?string
Filter charges by order ID (comma-separated for multiple values)
Default
""order_by?string
Order by field
Default
"created_at"Value in
- "created_at"
- "updated_at"
order?string
Order direction
Value in
- "asc"
- "desc"
page?number
Page number (0-based)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/charges"{ "data": [ { "pricing_trace": { "rate_card_id": "string", "rate_card_name": "string", "version_id": "string", "semantic_version": "string", "category": "STORAGE", "decision": "pricing_matched", "trigger_step_id": "string", "pricing_step_id": "string", "calculated_amount": 0, "calculation_note": "string", "pricing_config": { "category": "SHIPPING", "original_amount": 0.1, "origination": "ORDER", "shipping_label": { "from_address_country": "string", "from_address_zip": "string", "from_address_state": "string", "from_address_city": "string", "to_address_country": "string", "to_address_zip": "string", "to_address_state": "string", "to_address_city": "string", "zone": "string", "price": 0.1, "formatted_service": "string", "service_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carrier_integration_id": "string", "carrier_id": "string", "tracking_code": "string", "id": "string" }, "order": { "address_residential": "UNKNOWN", "priority": "LOW", "is_fragile": true, "tags": [ "string" ], "unique_core_line_item_count": 0.1, "shop_type": "SHOPIFY", "order_number": "string", "id": "string" } }, "events": [ { "event_type": "trigger", "step_id": "string", "category": "STORAGE", "matched": true } ] }, "pricing_config": { "category": "SHIPPING", "original_amount": 0.1, "origination": "ORDER", "shipping_label": { "from_address_country": "string", "from_address_zip": "string", "from_address_state": "string", "from_address_city": "string", "to_address_country": "string", "to_address_zip": "string", "to_address_state": "string", "to_address_city": "string", "zone": "string", "price": 0.1, "formatted_service": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "tracking_code": "string" }, "order": { "address_residential": "UNKNOWN", "priority": "LOW", "is_fragile": true, "tags": [ "string" ], "unique_core_line_item_count": 0.1, "shop_type": "SHOPIFY", "order_number": "string" } }, "location_type_name": "string", "location_type_id": "string", "warehouse_name": "string", "warehouse_id": "string", "carton_name": "string", "carton_id": "string", "service_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carrier_integration_id": "string", "carrier_id": "string", "purchase_order_id": "string", "shipping_label_id": "string", "return_id": "string", "work_order_id": "string", "order_id": "string", "fulfillment_id": "string", "fulfillment_order_id": "string", "invoice_id": "string", "fulfillment_delegation_id": "string", "merchant_team_id": "string", "fulfiller_team_id": "string", "quantity": 0, "calculated_amount": 0, "original_amount": 0, "currency": "string", "category": "STORAGE", "description": "string", "name": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string", "supported_actions": [ { "action": "VIEW_CHARGE" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}