Fulfillment.com APIv2

/**
 * FulfillmentcomAPIv2 - generated by OmniStream from Fulfillment.com APIv2's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/fulfillment";

export class FulfillmentcomAPIv2Error extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `FulfillmentcomAPIv2 error ${status}`);
    this.name = "FulfillmentcomAPIv2Error";
    this.status = status;
    this.code = code;
  }
}

export interface FulfillmentcomAPIv2Options {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class FulfillmentcomAPIv2 {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: FulfillmentcomAPIv2Options = {}) {
    if (!token) throw new Error("FulfillmentcomAPIv2: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new FulfillmentcomAPIv2Error(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** List Order Accounting */
  getAccounting(params: { "fromDate": string; "toDate": string; "hydrate": unknown[]; "page"?: number; "limit"?: number; "warehouseIds"?: unknown[]; "orderIds"?: unknown[] }): Promise<any> {
    return this._request("GET", "/accounting", { params });
  }

  /** List of Item Inventories */
  getInventory(params: { "page"?: number; "limit"?: number; "merchantIds"?: unknown[]; "warehouseIds"?: unknown[]; "externalSkuNames"?: unknown[] }): Promise<any> {
    return this._request("GET", "/inventory", { params });
  }

  /** Generate an Access Token */
  postOauthAccessToken(body: unknown): Promise<any> {
    return this._request("POST", "/oauth/access_token", { body });
  }

  /** List of Orders */
  getOrders(params: { "fromDate": string; "toDate": string; "merchantIds"?: unknown[]; "warehouseIds"?: unknown[]; "page"?: number; "limit"?: number; "hydrate"?: unknown[] }): Promise<any> {
    return this._request("GET", "/orders", { params });
  }

  /** New Order */
  postOrders(body: unknown): Promise<any> {
    return this._request("POST", "/orders", { body });
  }

  /** Order Details */
  getOrder(params: { "id": string; "merchantId"?: number; "hydrate"?: unknown[] }): Promise<any> {
    return this._request("GET", "/orders/{id}", { params });
  }

  /** Cancel an Order */
  deleteOrdersId(params: { "id": number }): Promise<any> {
    return this._request("DELETE", "/orders/{id}", { params });
  }

  /** Ship an Order */
  putOrdersIdShip(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/orders/{id}/ship", { body, params });
  }

  /** Update Order Status */
  putOrdersIdStatus(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/orders/{id}/status", { body, params });
  }

  /** List Returns */
  getReturns(params: { "fromDate": string; "toDate": string; "page"?: number; "limit"?: number }): Promise<any> {
    return this._request("GET", "/returns", { params });
  }

  /** Inform us of an RMA */
  putReturns(body: unknown): Promise<any> {
    return this._request("PUT", "/returns", { body });
  }

  /** Tracking */
  getTrack(params: { "trackingNumber"?: string }): Promise<any> {
    return this._request("GET", "/track", { params });
  }

  /** About Me */
  getUsersMe(): Promise<any> {
    return this._request("GET", "/users/me", {});
  }
}

export default FulfillmentcomAPIv2;