@shopify/shopify-api 13.0.0 → 13.1.0

package/rest/admin/2026-04/fulfillment_event.ts

@@ -0,0 +1,129 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+import {Country} from './country';
+import {Province} from './province';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  order_id?: number | string | null;
+  fulfillment_id?: number | string | null;
+  event_id?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+  order_id?: number | string | null;
+  fulfillment_id?: number | string | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+  fulfillment_id?: number | string | null;
+}
+
+export class FulfillmentEvent extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "country": Country,
+    "province": Province
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["order_id", "fulfillment_id", "id"], "path": "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id", "fulfillment_id"], "path": "orders/<order_id>/fulfillments/<fulfillment_id>/events.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id", "fulfillment_id", "id"], "path": "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["order_id", "fulfillment_id"], "path": "orders/<order_id>/fulfillments/<fulfillment_id>/events.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "fulfillment_event",
+      "plural": "fulfillment_events"
+    }
+  ];
+
+  protected static getJsonBodyName(): string
+  {
+    return "event";
+  }
+
+  public static async find(
+    {
+      session,
+      id,
+      order_id = null,
+      fulfillment_id = null,
+      event_id = null
+    }: FindArgs
+  ): Promise<FulfillmentEvent | null> {
+    const result = await this.baseFind<FulfillmentEvent>({
+      session: session,
+      urlIds: {"id": id, "order_id": order_id, "fulfillment_id": fulfillment_id},
+      params: {"event_id": event_id},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id,
+      order_id = null,
+      fulfillment_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentEvent>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id, "order_id": order_id, "fulfillment_id": fulfillment_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      order_id = null,
+      fulfillment_id = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<FulfillmentEvent>> {
+    const response = await this.baseFind<FulfillmentEvent>({
+      session: session,
+      urlIds: {"order_id": order_id, "fulfillment_id": fulfillment_id},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public address1: string | null;
+  public city: string | null;
+  public country: Country | null | {[key: string]: any};
+  public created_at: string | null;
+  public estimated_delivery_at: string | null;
+  public fulfillment_id: string | null;
+  public happened_at: string | null;
+  public id: string | null;
+  public latitude: number | null;
+  public longitude: number | null;
+  public message: string | null;
+  public order_id: string | null;
+  public province: Province | null | {[key: string]: any};
+  public shop_id: string | null;
+  public status: string | null;
+  public updated_at: string | null;
+  public zip: string | null;
+}

package/rest/admin/2026-04/fulfillment_order.ts

@@ -0,0 +1,296 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  include_financial_summaries?: unknown;
+  include_order_reference_fields?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+  include_financial_summaries?: unknown;
+  include_order_reference_fields?: unknown;
+}
+interface CancelArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface CloseArgs {
+  [key: string]: unknown;
+  message?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface HoldArgs {
+  [key: string]: unknown;
+  fulfillment_hold?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface MoveArgs {
+  [key: string]: unknown;
+  fulfillment_order?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface OpenArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface ReleaseHoldArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface RescheduleArgs {
+  [key: string]: unknown;
+  new_fulfill_at?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface SetFulfillmentOrdersDeadlineArgs {
+  [key: string]: unknown;
+  fulfillment_order_ids?: unknown;
+  fulfillment_deadline?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class FulfillmentOrder extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "fulfillment_orders/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id"], "path": "orders/<order_id>/fulfillment_orders.json"},
+    {"http_method": "post", "operation": "cancel", "ids": ["id"], "path": "fulfillment_orders/<id>/cancel.json"},
+    {"http_method": "post", "operation": "close", "ids": ["id"], "path": "fulfillment_orders/<id>/close.json"},
+    {"http_method": "post", "operation": "hold", "ids": ["id"], "path": "fulfillment_orders/<id>/hold.json"},
+    {"http_method": "post", "operation": "move", "ids": ["id"], "path": "fulfillment_orders/<id>/move.json"},
+    {"http_method": "post", "operation": "open", "ids": ["id"], "path": "fulfillment_orders/<id>/open.json"},
+    {"http_method": "post", "operation": "release_hold", "ids": ["id"], "path": "fulfillment_orders/<id>/release_hold.json"},
+    {"http_method": "post", "operation": "reschedule", "ids": ["id"], "path": "fulfillment_orders/<id>/reschedule.json"},
+    {"http_method": "post", "operation": "set_fulfillment_orders_deadline", "ids": [], "path": "fulfillment_orders/set_fulfillment_orders_deadline.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "fulfillment_order",
+      "plural": "fulfillment_orders"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      include_financial_summaries = null,
+      include_order_reference_fields = null
+    }: FindArgs
+  ): Promise<FulfillmentOrder | null> {
+    const result = await this.baseFind<FulfillmentOrder>({
+      session: session,
+      urlIds: {"id": id},
+      params: {"include_financial_summaries": include_financial_summaries, "include_order_reference_fields": include_order_reference_fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      order_id = null,
+      include_financial_summaries = null,
+      include_order_reference_fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<FulfillmentOrder>> {
+    const response = await this.baseFind<FulfillmentOrder>({
+      session: session,
+      urlIds: {"order_id": order_id},
+      params: {"include_financial_summaries": include_financial_summaries, "include_order_reference_fields": include_order_reference_fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public async cancel(
+    {
+      body = null,
+      ...otherArgs
+    }: CancelArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "cancel",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async close(
+    {
+      message = null,
+      body = null,
+      ...otherArgs
+    }: CloseArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "close",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"message": message, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async hold(
+    {
+      fulfillment_hold = null,
+      body = null,
+      ...otherArgs
+    }: HoldArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "hold",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"fulfillment_hold": fulfillment_hold, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async move(
+    {
+      fulfillment_order = null,
+      body = null,
+      ...otherArgs
+    }: MoveArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "move",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"fulfillment_order": fulfillment_order, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async open(
+    {
+      body = null,
+      ...otherArgs
+    }: OpenArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "open",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async release_hold(
+    {
+      body = null,
+      ...otherArgs
+    }: ReleaseHoldArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "release_hold",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async reschedule(
+    {
+      new_fulfill_at = null,
+      body = null,
+      ...otherArgs
+    }: RescheduleArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "reschedule",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"new_fulfill_at": new_fulfill_at, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async set_fulfillment_orders_deadline(
+    {
+      fulfillment_order_ids = null,
+      fulfillment_deadline = null,
+      body = null,
+      ...otherArgs
+    }: SetFulfillmentOrdersDeadlineArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentOrder>({
+      http_method: "post",
+      operation: "set_fulfillment_orders_deadline",
+      session: this.session,
+      urlIds: {},
+      params: {"fulfillment_order_ids": fulfillment_order_ids, "fulfillment_deadline": fulfillment_deadline, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public assigned_location: {[key: string]: unknown} | null;
+  public assigned_location_id: string | null;
+  public created_at: string | null;
+  public delivery_method: {[key: string]: unknown} | null;
+  public destination: {[key: string]: unknown} | null;
+  public fulfill_at: string | null;
+  public fulfill_by: string | null;
+  public fulfillment_holds: {[key: string]: unknown}[] | null;
+  public id: string | null;
+  public international_duties: {[key: string]: unknown} | null;
+  public line_items: {[key: string]: unknown}[] | null;
+  public merchant_requests: {[key: string]: unknown}[] | null;
+  public order_id: string | null;
+  public request_status: string | null;
+  public shop_id: string | null;
+  public status: string | null;
+  public supported_actions: string[] | null;
+  public updated_at: string | null;
+}

package/rest/admin/2026-04/fulfillment_request.ts

@@ -0,0 +1,91 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {ApiVersion} from '../../../lib/types';
+
+interface AcceptArgs {
+  [key: string]: unknown;
+  message?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface RejectArgs {
+  [key: string]: unknown;
+  message?: unknown;
+  reason?: unknown;
+  line_items?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class FulfillmentRequest extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "post", "operation": "accept", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/accept.json"},
+    {"http_method": "post", "operation": "post", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/fulfillment_request.json"},
+    {"http_method": "post", "operation": "reject", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "submitted_fulfillment_order",
+      "plural": "submitted_fulfillment_orders"
+    },
+    {
+      "singular": "fulfillment_order",
+      "plural": "fulfillment_orders"
+    }
+  ];
+
+  public async accept(
+    {
+      message = null,
+      body = null,
+      ...otherArgs
+    }: AcceptArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentRequest>({
+      http_method: "post",
+      operation: "accept",
+      session: this.session,
+      urlIds: {"fulfillment_order_id": this.fulfillment_order_id},
+      params: {"message": message, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async reject(
+    {
+      message = null,
+      reason = null,
+      line_items = null,
+      body = null,
+      ...otherArgs
+    }: RejectArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentRequest>({
+      http_method: "post",
+      operation: "reject",
+      session: this.session,
+      urlIds: {"fulfillment_order_id": this.fulfillment_order_id},
+      params: {"message": message, "reason": reason, "line_items": line_items, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public fulfillment_order_id: string | null;
+  public kind: string | null;
+  public message: string | null;
+  public request_options: {[key: string]: unknown} | null;
+  public response_data: {[key: string]: unknown} | null;
+  public sent_at: string | null;
+}

package/rest/admin/2026-04/fulfillment_service.ts

@@ -0,0 +1,101 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  scope?: unknown;
+}
+
+export class FulfillmentService extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "fulfillment_services/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "fulfillment_services.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "fulfillment_services/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "fulfillment_services.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "fulfillment_services/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "fulfillment_service",
+      "plural": "fulfillment_services"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<FulfillmentService | null> {
+    const result = await this.baseFind<FulfillmentService>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<FulfillmentService>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      scope = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<FulfillmentService>> {
+    const response = await this.baseFind<FulfillmentService>({
+      session: session,
+      urlIds: {},
+      params: {"scope": scope, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public admin_graphql_api_id: string | null;
+  public callback_url: string | null;
+  public fulfillment_orders_opt_in: boolean | null;
+  public handle: string | null;
+  public id: string | null;
+  public inventory_management: boolean | null;
+  public location_id: string | null;
+  public name: string | null;
+  public provider_id: string | null;
+  public requires_shipping_method: boolean | null;
+  public tracking_support: boolean | null;
+}