OrdersResource class

The orders endpoints with client already applied.

Constructors

OrdersResource(ExsitedClient client): Bind the resource to a client; normally reached via client.orders.
const

Properties

client → ExsitedClient: The client every call below is made through.
final
hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

acceptOrder(Object orderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/accept
activateOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/activate
activateOrderInvoiceFromDormant(Object orderId, Object invoiceUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/activate_invoice_from_dormant/{invoice_uuid}
adjustOrderContract(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/contract_adjustment
cancelOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/cancel
changeOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/change
changeOrderStatus(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/change_status
createOrder(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders
createOrderActivateDraft(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/activate_draft
createOrderConvertToOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/convert_to_order
createOrderDiscardDraft(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderDiscardDraft>>: POST /api/{api_version}/orders/{order_id}/discard_draft
createOrderExpress(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/express
createOrderExtendTrial(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderExtendTrial>>: POST /api/{api_version}/orders/{order_id}/extend_trial
createOrderNote(Object orderId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteView>>: POST /api/{api_version}/orders/{order_id}/notes
createOrderRelinquish(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/relinquish
deleteOrder(Object orderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/orders/{order_id}
deleteOrderNote(Object orderId, Object orderNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/orders/{order_id}/notes/{order_note_id}
deleteOrderNoteFile(Object orderId, Object orderNoteId, Object orderFileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/orders/{order_id}/notes/{order_note_id}/files/{order_file_id}
downgradeOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/downgrade
getOrder(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: GET /api/{api_version}/orders/{order_id}
getOrderBillingPreferences(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderBillingPreferences>>: GET /api/{api_version}/orders/{order_id}/billing_preferences
getOrderCustomObject(Object orderId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderCustomObject>>: GET /api/{api_version}/orders/{order_id}/custom_objects/{custom_object_id}
getOrderCustomObjectInstance(Object orderId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/orders/{order_id}/custom_objects/{custom_object_id}/instances/{instance_id}
getOrderCustomObjects(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountOrders>>: GET /api/{api_version}/orders/{order_id}/custom_objects
getOrderCustomObjectsInstance(Object orderId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderCustomObject>>: GET /api/{api_version}/orders/{order_id}/custom_objects_instances/{custom_object_id}
getOrderCustomObjectsInstanceInstance(Object orderId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/orders/{order_id}/custom_objects_instances/{custom_object_id}/instances/{instance_id}
getOrderCustomObjectsInstances(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountOrders>>: GET /api/{api_version}/orders/{order_id}/custom_objects_instances
getOrderInformation(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderInformation>>: GET /api/{api_version}/orders/{order_id}/information
getOrderItemFulfillment(Object orderId, Object fulfillmentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderItemFulfillment>>: GET /api/{api_version}/orders/{order_id}/item_fulfillments/{fulfillment_id}
getOrderItemFulfillments(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<AccountOrders>>: GET /api/{api_version}/orders/{order_id}/item_fulfillments
getOrderKpis(Object orderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderKpis>>: GET /api/{api_version}/orders/{order_id}/kpis
getOrderLine(Object orderId, Object lineUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderLine>>: GET /api/{api_version}/orders/{order_id}/lines/{line_uuid}
getOrderLines(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderLines>>: GET /api/{api_version}/orders/{order_id}/lines
getOrderNote(Object orderId, Object orderNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteView>>: GET /api/{api_version}/orders/{order_id}/notes/{order_note_id}
getOrderNoteFile(Object orderId, Object orderNoteId, Object orderFileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteFile>>: GET /api/{api_version}/orders/{order_id}/notes/{order_note_id}/files/{order_file_id}
getOrderNoteFiles(Object orderId, Object orderNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteFileList>>: GET /api/{api_version}/orders/{order_id}/notes/{order_note_id}/files
getOrderNotes(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteList>>: GET /api/{api_version}/orders/{order_id}/notes
getOrderPayment(Object orderId, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderPayment>>: GET /api/{api_version}/orders/{order_id}/payments/{payment_id}
getOrderPaymentMethod(Object orderId, Object paymentMethodRef, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderPaymentMethod>>: GET /api/{api_version}/orders/{order_id}/payment_methods/{payment_method_ref}
getOrderPaymentMethods(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderPaymentMethods>>: GET /api/{api_version}/orders/{order_id}/payment_methods
getOrderPdf(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderPdf>>: GET /api/{api_version}/orders/{order_id}/pdf
getOrderQuotePartialInvoices(Object orderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderQuotePartialInvoices>>: GET /api/{api_version}/orders/{order_id}/quote_partial_invoices
getOrders({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderList>>: GET /api/{api_version}/orders
getOrderShippingPdf(Object orderId, Object shippingLineId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/orders/{order_id}/shipping_pdf/{shipping_line_id}
getOrdersNotes({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteList>>: GET /api/{api_version}/orders/notes
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
previewOrder(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/preview
previewOrderChange(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/change/preview
previewOrderContractAdjustment(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/contract_adjustment/preview
previewOrderDowngrade(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/downgrade/preview
previewOrderUpgrade(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/upgrade/preview
reactivateOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: POST /api/{api_version}/orders/{order_id}/reactivate
replaceOrderBillingPreferences(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PUT /api/{api_version}/orders/{order_id}/billing_preferences
replaceOrderLineBillingPreferences(Object orderId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PUT /api/{api_version}/orders/{order_id}/lines/{line_uuid}/billing_preferences
terminateOrderTrial(Object orderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/terminate_trial
toString() → String: A string representation of this object.
inherited
updateOrderBillingPreferences(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PATCH /api/{api_version}/orders/{order_id}/billing_preferences
updateOrderInformation(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PATCH /api/{api_version}/orders/{order_id}/information
updateOrderLine(Object orderId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PATCH /api/{api_version}/orders/{order_id}/lines/{line_uuid}
updateOrderLineBillingPreferences(Object orderId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderRead>>: PATCH /api/{api_version}/orders/{order_id}/lines/{line_uuid}/billing_preferences
updateOrderNote(Object orderId, Object orderNoteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderNoteView>>: PATCH /api/{api_version}/orders/{order_id}/notes/{order_note_id}
upgradeOrder(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/orders/{order_id}/upgrade

Operators

operator ==(Object other) → bool: The equality operator.
inherited

OrdersResource class

Constructors

Properties

Methods

Operators

orders library