// This file is auto-generated by oagen. Do not edit.
use crate::client::Client;
#[allow(unused_imports)]
use crate::enums::*;
use crate::error::Error;
#[allow(unused_imports)]
use crate::models::*;
#[allow(unused_imports)]
use serde::Serialize;
pub struct OrdersApi<'a> {
pub(crate) client: &'a Client,
}
#[derive(Debug, Clone, Serialize)]
pub struct ListParams {
/// Number of items to return per page.
///
/// Defaults to `15`.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<i64>,
/// Page number to return.
///
/// Defaults to `1`.
#[serde(skip_serializing_if = "Option::is_none")]
pub page: Option<i64>,
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
impl Default for ListParams {
#[allow(deprecated)]
fn default() -> Self {
Self {
limit: Some(15),
page: Some(1),
x_store: Default::default(),
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCreateOrderRequestApplicationJson,
}
impl CreateParams {
/// Construct a new `CreateParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCreateOrderRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct SearchParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkSearchOrdersRequestApplicationJson,
}
impl SearchParams {
/// Construct a new `SearchParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkSearchOrdersRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct GetParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
#[derive(Debug, Clone, Serialize)]
pub struct UpdateStatusParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkUpdateOrderStatusRequestApplicationJson,
}
impl UpdateStatusParams {
/// Construct a new `UpdateStatusParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkUpdateOrderStatusRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateCheckoutParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCreateOrderCheckoutRequestApplicationJson,
}
impl CreateCheckoutParams {
/// Construct a new `CreateCheckoutParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCreateOrderCheckoutRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateReplacementParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCreateOrderReplacementRequestApplicationJson,
}
impl CreateReplacementParams {
/// Construct a new `CreateReplacementParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCreateOrderReplacementRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateRefundParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCreateOrderRefundRequestApplicationJson,
}
impl CreateRefundParams {
/// Construct a new `CreateRefundParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCreateOrderRefundRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct RetryFulfillmentParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkRetryOrderFulfillmentRequestApplicationJson,
}
impl RetryFulfillmentParams {
/// Construct a new `RetryFulfillmentParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkRetryOrderFulfillmentRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct RetryDynamicDeliveryParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkRetryOrderDynamicDeliveryRequestApplicationJson,
}
impl RetryDynamicDeliveryParams {
/// Construct a new `RetryDynamicDeliveryParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkRetryOrderDynamicDeliveryRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct SendFulfillmentNotificationsParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkSendOrderFulfillmentNotificationsRequestApplicationJson,
}
impl SendFulfillmentNotificationsParams {
/// Construct a new `SendFulfillmentNotificationsParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkSendOrderFulfillmentNotificationsRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct ListDeliverablesParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
#[derive(Debug, Clone, Serialize)]
pub struct CreateFromWalletParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCreateWalletOrderRequestApplicationJson,
}
impl CreateFromWalletParams {
/// Construct a new `CreateFromWalletParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCreateWalletOrderRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct PayFromWalletParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkPayOrderFromWalletRequestApplicationJson,
}
impl PayFromWalletParams {
/// Construct a new `PayFromWalletParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkPayOrderFromWalletRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
impl<'a> OrdersApi<'a> {
/// List orders
///
/// List orders for the selected store. Requires the invoice token ability. Results include customer and payment-provider summaries without sensitive data, totals in integer minor units, status timelines, and product-level line-item summaries from the same store. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn list(
&self,
params: ListParams,
) -> Result<SdkListOrdersResponseValue200ApplicationJson, Error> {
self.list_with_options(params, None).await
}
/// Variant of [`Self::list`] that accepts per-request [`crate::RequestOptions`].
pub async fn list_with_options(
&self,
params: ListParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkListOrdersResponseValue200ApplicationJson, Error> {
self.list_raw(params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn list_raw(
&self,
params: ListParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkListOrdersResponseValue200ApplicationJson>, Error> {
let path = "/v2/orders".to_string();
let method = http::Method::GET;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("listOrders".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(method, &path, ¶ms, options, "GET /v2/orders")
.await
}
/// Create an order
///
/// Create an order with one or more product-variant line items and start checkout. This can create provider payment sessions, reserve stock or wallet funds, and begin fulfillment for a free or fully wallet-funded order. Requires the invoice ability or orders:write OAuth scope and current store permission. Use the same Idempotency-Key and identical body after a lost response; inspect the order before creating a new key. The payment.checkout_url is a handoff, not proof of payment. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn create(
&self,
params: CreateParams,
) -> Result<SdkCreateOrderResponseValue201ApplicationJson, Error> {
self.create_with_options(params, None).await
}
/// Variant of [`Self::create`] that accepts per-request [`crate::RequestOptions`].
pub async fn create_with_options(
&self,
params: CreateParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCreateOrderResponseValue201ApplicationJson, Error> {
self.create_raw(params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn create_raw(
&self,
params: CreateParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkCreateOrderResponseValue201ApplicationJson>, Error> {
let path = "/v2/orders".to_string();
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("createOrder".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders",
)
.await
}
/// Search orders
///
/// Find orders using the same filters as the list endpoint. Requires the invoice token ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn search(
&self,
params: SearchParams,
) -> Result<SdkSearchOrdersResponseValue200ApplicationJson, Error> {
self.search_with_options(params, None).await
}
/// Variant of [`Self::search`] that accepts per-request [`crate::RequestOptions`].
pub async fn search_with_options(
&self,
params: SearchParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkSearchOrdersResponseValue200ApplicationJson, Error> {
self.search_raw(params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn search_raw(
&self,
params: SearchParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkSearchOrdersResponseValue200ApplicationJson>, Error> {
let path = "/v2/orders/search".to_string();
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("searchOrders".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/search",
)
.await
}
/// Retrieve an order
///
/// Retrieve an order and its product-level line-item summaries from the same store. Requires the invoice token ability. An ID from another store returns not found. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn get(
&self,
order: &str,
params: GetParams,
) -> Result<SdkGetOrderResponseValue200ApplicationJson, Error> {
self.get_with_options(order, params, None).await
}
/// Variant of [`Self::get`] that accepts per-request [`crate::RequestOptions`].
pub async fn get_with_options(
&self,
order: &str,
params: GetParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkGetOrderResponseValue200ApplicationJson, Error> {
self.get_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn get_raw(
&self,
order: &str,
params: GetParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkGetOrderResponseValue200ApplicationJson>, Error> {
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}");
let method = http::Method::GET;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("getOrder".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"GET /v2/orders/{order}",
)
.await
}
/// Update order status
///
/// Change order lifecycle state. COMPLETED finalizes fulfillment of an already paid/partial/disputing order; it does not capture a pending payment. VOIDED can schedule provider side effects. REVIEW and DISPUTING have state restrictions. Send expected_status to prevent overwriting a changed state; an invalid transition, stale status, or busy lifecycle lock returns 422. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn update_status(
&self,
order: &str,
params: UpdateStatusParams,
) -> Result<SdkUpdateOrderStatusResponseValue200ApplicationJson, Error> {
self.update_status_with_options(order, params, None).await
}
/// Variant of [`Self::update_status`] that accepts per-request [`crate::RequestOptions`].
pub async fn update_status_with_options(
&self,
order: &str,
params: UpdateStatusParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkUpdateOrderStatusResponseValue200ApplicationJson, Error> {
self.update_status_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn update_status_raw(
&self,
order: &str,
params: UpdateStatusParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkUpdateOrderStatusResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/status");
let method = http::Method::PATCH;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("updateOrderStatus".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"PATCH /v2/orders/{order}/status",
)
.await
}
/// Create order checkout
///
/// Start or reuse checkout for a PENDING order. A new nonfree checkout returns 201; an existing payment session or free order returns 200. Free or fully wallet-funded checkout can mark the order paid. Failures can mark the order FAILED and release wallet reservations. Do not infer payment from a checkout URL or browser return. The optional expected_status field is validated but is not a checkout concurrency precondition. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn create_checkout(
&self,
order: &str,
params: CreateCheckoutParams,
) -> Result<SdkCreateOrderCheckoutResponseValue200ApplicationJson, Error> {
self.create_checkout_with_options(order, params, None).await
}
/// Variant of [`Self::create_checkout`] that accepts per-request [`crate::RequestOptions`].
pub async fn create_checkout_with_options(
&self,
order: &str,
params: CreateCheckoutParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCreateOrderCheckoutResponseValue200ApplicationJson, Error> {
self.create_checkout_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn create_checkout_raw(
&self,
order: &str,
params: CreateCheckoutParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkCreateOrderCheckoutResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/checkout");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("createOrderCheckout".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/checkout",
)
.await
}
/// Issue replacements
///
/// Create a replacement order and begin fulfillment for selected purchased variants. Supply a variant ID, an array of variant IDs, or a map of variant IDs to replacement quantities (null means original quantity). Variants must belong to this order; replacement quantities cannot exceed purchased quantity or available stock. Already replaced deliveries cannot be replaced again. The returned ID belongs to the new replacement order. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn create_replacement(
&self,
order: &str,
params: CreateReplacementParams,
) -> Result<SdkCreateOrderReplacementResponseValue200ApplicationJson, Error> {
self.create_replacement_with_options(order, params, None)
.await
}
/// Variant of [`Self::create_replacement`] that accepts per-request [`crate::RequestOptions`].
pub async fn create_replacement_with_options(
&self,
order: &str,
params: CreateReplacementParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCreateOrderReplacementResponseValue200ApplicationJson, Error> {
self.create_replacement_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn create_replacement_raw(
&self,
order: &str,
params: CreateReplacementParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkCreateOrderReplacementResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/replacements");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("createOrderReplacement".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/replacements",
)
.await
}
/// Refund an order
///
/// Request a real refund for a completed, nonsubscription order with refundable balance and a supported provider. amount is a decimal string in the order currency: "5.00" means $5.00 in USD, not 500 cents. Omitting amount, sending null, or an empty string requests the FULL remaining balance. Do not send amount_cents: it is not a request field. Inspect refund.status (pending/effective/failed/cancelled); a 200 response does not guarantee money has reached the customer. Retrieve refund state before retrying an uncertain provider outcome. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn create_refund(
&self,
order: &str,
params: CreateRefundParams,
) -> Result<SdkCreateOrderRefundResponseValue200ApplicationJson, Error> {
self.create_refund_with_options(order, params, None).await
}
/// Variant of [`Self::create_refund`] that accepts per-request [`crate::RequestOptions`].
pub async fn create_refund_with_options(
&self,
order: &str,
params: CreateRefundParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCreateOrderRefundResponseValue200ApplicationJson, Error> {
self.create_refund_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn create_refund_raw(
&self,
order: &str,
params: CreateRefundParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkCreateOrderRefundResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/refunds");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("createOrderRefund".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/refunds",
)
.await
}
/// Retry fulfillment
///
/// Reset fulfillment effects for a PAID or PARTIAL order and retry delivery. The optional email overrides the recipient. meta.effects_reset counts reset effects; it does not prove fulfillment finished. Other order states and a busy lifecycle lock return 422. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn retry_fulfillment(
&self,
order: &str,
params: RetryFulfillmentParams,
) -> Result<SdkRetryOrderFulfillmentResponseValue200ApplicationJson, Error> {
self.retry_fulfillment_with_options(order, params, None)
.await
}
/// Variant of [`Self::retry_fulfillment`] that accepts per-request [`crate::RequestOptions`].
pub async fn retry_fulfillment_with_options(
&self,
order: &str,
params: RetryFulfillmentParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkRetryOrderFulfillmentResponseValue200ApplicationJson, Error> {
self.retry_fulfillment_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn retry_fulfillment_raw(
&self,
order: &str,
params: RetryFulfillmentParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkRetryOrderFulfillmentResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/fulfillment-retries");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("retryOrderFulfillment".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/fulfillment-retries",
)
.await
}
/// Retry dynamic delivery
///
/// Queue another dynamic delivery attempt for one delivered product of a COMPLETED order. The delivered product, line item and currently dynamic variant must all belong to this order and store, with a configured webhook. 202 and meta.queued acknowledge the retry request, not successful external delivery. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn retry_dynamic_delivery(
&self,
order: &str,
params: RetryDynamicDeliveryParams,
) -> Result<SdkRetryOrderDynamicDeliveryResponseValue202ApplicationJson, Error> {
self.retry_dynamic_delivery_with_options(order, params, None)
.await
}
/// Variant of [`Self::retry_dynamic_delivery`] that accepts per-request [`crate::RequestOptions`].
pub async fn retry_dynamic_delivery_with_options(
&self,
order: &str,
params: RetryDynamicDeliveryParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkRetryOrderDynamicDeliveryResponseValue202ApplicationJson, Error> {
self.retry_dynamic_delivery_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn retry_dynamic_delivery_raw(
&self,
order: &str,
params: RetryDynamicDeliveryParams,
options: Option<&crate::RequestOptions>,
) -> Result<
crate::RawResponse<SdkRetryOrderDynamicDeliveryResponseValue202ApplicationJson>,
Error,
> {
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/dynamic-delivery-retries");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("retryOrderDynamicDelivery".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/dynamic-delivery-retries",
)
.await
}
/// Send fulfillment notifications
///
/// Send delivery notifications for each selected purchased variant. Omit product_variant_ids to select all variants. A supplied list must contain distinct positive IDs belonging to this order and store. Noncompleted orders or a missing recipient return meta.notifications_sent=0. The count records notifications requested, not email delivery confirmation. Requires the invoice ability or orders:write OAuth scope and current store permission. Idempotency-Key is required. Reuse the same key and identical request after a lost response; changed input or an in-progress request returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn send_fulfillment_notifications(
&self,
order: &str,
params: SendFulfillmentNotificationsParams,
) -> Result<SdkSendOrderFulfillmentNotificationsResponseValue200ApplicationJson, Error> {
self.send_fulfillment_notifications_with_options(order, params, None)
.await
}
/// Variant of [`Self::send_fulfillment_notifications`] that accepts per-request [`crate::RequestOptions`].
pub async fn send_fulfillment_notifications_with_options(
&self,
order: &str,
params: SendFulfillmentNotificationsParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkSendOrderFulfillmentNotificationsResponseValue200ApplicationJson, Error> {
self.send_fulfillment_notifications_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn send_fulfillment_notifications_raw(
&self,
order: &str,
params: SendFulfillmentNotificationsParams,
options: Option<&crate::RequestOptions>,
) -> Result<
crate::RawResponse<SdkSendOrderFulfillmentNotificationsResponseValue200ApplicationJson>,
Error,
> {
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/fulfillment-notifications");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("sendOrderFulfillmentNotifications".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/fulfillment-notifications",
)
.await
}
/// List order deliverables
///
/// List seller-visible fulfillment records, expanding purchased bundle snapshots into their component variants. File download links expire after one hour. This payload includes line-item and variant IDs but does not expose the delivered_product_id required for dynamic delivery retries. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn list_deliverables(
&self,
order: &str,
params: ListDeliverablesParams,
) -> Result<SdkListOrderDeliverablesResponseValue200ApplicationJson, Error> {
self.list_deliverables_with_options(order, params, None)
.await
}
/// Variant of [`Self::list_deliverables`] that accepts per-request [`crate::RequestOptions`].
pub async fn list_deliverables_with_options(
&self,
order: &str,
params: ListDeliverablesParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkListOrderDeliverablesResponseValue200ApplicationJson, Error> {
self.list_deliverables_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn list_deliverables_raw(
&self,
order: &str,
params: ListDeliverablesParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkListOrderDeliverablesResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/deliverables");
let method = http::Method::GET;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("listOrderDeliverables".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"GET /v2/orders/{order}/deliverables",
)
.await
}
/// Create and pay an order from a wallet
///
/// Create an order and debit the customer's wallet in one atomic call. This spends real wallet funds and queues normal fulfillment; PAID means payment was captured, while COMPLETED depends on fulfillment. Requires both invoice and wallet:write API-key abilities and both store permissions. Wallets must be enabled, the customer must already exist in this store, and an active wallet must cover the entire positive total after discounts and taxes. Subscriptions and partial wallet payments are not supported. Omit payment_method and custom_payment_method_id. An insufficient balance or invalid cart returns 422 without creating an order or debit. Send the required Idempotency-Key; retry an identical request with the same key after a lost response. Reusing it with different input returns 409. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn create_from_wallet(
&self,
params: CreateFromWalletParams,
) -> Result<SdkCreateWalletOrderResponseValue201ApplicationJson, Error> {
self.create_from_wallet_with_options(params, None).await
}
/// Variant of [`Self::create_from_wallet`] that accepts per-request [`crate::RequestOptions`].
pub async fn create_from_wallet_with_options(
&self,
params: CreateFromWalletParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCreateWalletOrderResponseValue201ApplicationJson, Error> {
self.create_from_wallet_raw(params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn create_from_wallet_raw(
&self,
params: CreateFromWalletParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkCreateWalletOrderResponseValue201ApplicationJson>, Error>
{
let path = "/v2/orders/wallet".to_string();
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("createWalletOrder".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/wallet",
)
.await
}
/// Pay an existing order from its customer wallet
///
/// Debit the order's customer wallet for the complete stored order total and queue normal fulfillment. Requires both invoice and wallet:write API-key abilities and both store permissions. Only PENDING orders with pending lines, no subscription, and no existing payment method or checkout session are eligible. Active provider checkouts cannot be replaced. The store must enable wallets and the customer's active wallet must cover the full amount. The order ID determines the customer and amount; neither can be overridden. Send the required Idempotency-Key and reuse it with identical input after a lost response. A changed expected_status returns 409; an ineligible order or insufficient balance returns 422 without a debit. PAID does not guarantee fulfillment has completed. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn pay_from_wallet(
&self,
order: &str,
params: PayFromWalletParams,
) -> Result<SdkPayOrderFromWalletResponseValue200ApplicationJson, Error> {
self.pay_from_wallet_with_options(order, params, None).await
}
/// Variant of [`Self::pay_from_wallet`] that accepts per-request [`crate::RequestOptions`].
pub async fn pay_from_wallet_with_options(
&self,
order: &str,
params: PayFromWalletParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkPayOrderFromWalletResponseValue200ApplicationJson, Error> {
self.pay_from_wallet_raw(order, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn pay_from_wallet_raw(
&self,
order: &str,
params: PayFromWalletParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkPayOrderFromWalletResponseValue200ApplicationJson>, Error>
{
let order = crate::client::path_segment(order);
let path = format!("/v2/orders/{order}/wallet-payments");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = true;
merged.operation_id = Some("payOrderFromWallet".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/orders/{order}/wallet-payments",
)
.await
}
}