Skip to content

orders.md

Latest commit

 

History

History
544 lines (424 loc) · 13.8 KB

orders.md

File metadata and controls

544 lines (424 loc) · 13.8 KB

Orders

const ordersController = new OrdersController(client);

Class Name

OrdersController

Methods

Get Orders

Gets all orders

async getOrders(
  page?: number,
  size?: number,
  code?: string,
  status?: string,
  createdSince?: string,
  createdUntil?: string,
  customerId?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<ListOrderResponse>>

Parameters

Parameter Type Tags Description
page number | undefined Query, Optional Page number
size number | undefined Query, Optional Page size
code string | undefined Query, Optional Filter for order's code
status string | undefined Query, Optional Filter for order's status
createdSince string | undefined Query, Optional Filter for order's creation date start range
createdUntil string | undefined Query, Optional Filter for order's creation date end range
customerId string | undefined Query, Optional Filter for order's customer id
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

ListOrderResponse

Example Usage

try {
  const { result, ...httpResponse } = await ordersController.getOrders();
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Get Order Item

async getOrderItem(
  orderId: string,
  itemId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderItemResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order Id
itemId string Template, Required Item Id
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderItemResponse

Example Usage

const orderId = 'orderId2';
const itemId = 'itemId8';
try {
  const { result, ...httpResponse } = await ordersController.getOrderItem(orderId, itemId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Get Order

Gets an order

async getOrder(
  orderId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order id
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderResponse

Example Usage

const orderId = 'order_id6';
try {
  const { result, ...httpResponse } = await ordersController.getOrder(orderId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Close Order

async closeOrder(
  id: string,
  request: UpdateOrderStatusRequest,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderResponse>>

Parameters

Parameter Type Tags Description
id string Template, Required Order Id
request UpdateOrderStatusRequest Body, Required Update Order Model
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderResponse

Example Usage

const id = 'id0';
const request: UpdateOrderStatusRequest = {
  status: 'status8',
};

try {
  const { result, ...httpResponse } = await ordersController.closeOrder(id, request);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Create Order

Creates a new Order

async createOrder(
  body: CreateOrderRequest,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderResponse>>

Parameters

Parameter Type Tags Description
body CreateOrderRequest Body, Required Request for creating an order
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderResponse

Example Usage

const bodyItems: CreateOrderItemRequest[] = [];

const bodyitems0: CreateOrderItemRequest = {
  amount: 101,
  description: 'description3',
  quantity: 215,
  category: 'category1',
};

bodyItems[0] = bodyitems0;

const bodyitems1: CreateOrderItemRequest = {
  amount: 102,
  description: 'description4',
  quantity: 216,
  category: 'category2',
};

bodyItems[1] = bodyitems1;

const bodyitems2: CreateOrderItemRequest = {
  amount: 103,
  description: 'description5',
  quantity: 217,
  category: 'category3',
};

bodyItems[2] = bodyitems2;

const bodyCustomerAddressMetadata: Record<string, string> = {'key0' : 'metadata7', 'key1' : 'metadata6' } const bodyCustomerAddress: CreateAddressRequest = {
  street: 'street0',
  number: 'number8',
  zipCode: 'zip_code4',
  neighborhood: 'neighborhood6',
  city: 'city0',
  state: 'state6',
  country: 'country4',
  complement: 'complement6',
  metadata: bodyCustomerAddressMetadata,
  line1: 'line_16',
  line2: 'line_28',
};

const bodyCustomerMetadata: Record<string, string> = {'key0' : 'metadata9', 'key1' : 'metadata0' } const bodyCustomerPhones: CreatePhonesRequest = {};

const bodyCustomer: CreateCustomerRequest = {
  name: '{\n    "name": "Tony Stark"\n}',
  email: 'email2',
  document: 'document2',
  type: 'type6',
  address: bodyCustomerAddress,
  metadata: bodyCustomerMetadata,
  phones: bodyCustomerPhones,
  code: 'code2',
};

const bodyPayments: CreatePaymentRequest[] = [];

const bodypayments0: CreatePaymentRequest = {
  paymentMethod: 'payment_method0',
};

bodyPayments[0] = bodypayments0;

const bodypayments1: CreatePaymentRequest = {
  paymentMethod: 'payment_method9',
};

bodyPayments[1] = bodypayments1;

const bodyMetadata: Record<string, string> = {'key0' : 'metadata7', 'key1' : 'metadata8' } const body: CreateOrderRequest = {
  items: bodyItems,
  customer: bodyCustomer,
  payments: bodyPayments,
  code: 'code4',
  customerId: 'customer_id4',
  metadata: bodyMetadata,
  closed: true,
};

try {
  const { result, ...httpResponse } = await ordersController.createOrder(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Update Order Item

async updateOrderItem(
  orderId: string,
  itemId: string,
  request: UpdateOrderItemRequest,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderItemResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order Id
itemId string Template, Required Item Id
request UpdateOrderItemRequest Body, Required Item Model
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderItemResponse

Example Usage

const orderId = 'orderId2';
const itemId = 'itemId8';
const request: UpdateOrderItemRequest = {
  amount: 242,
  description: 'description6',
  quantity: 100,
  category: 'category4',
};

try {
  const { result, ...httpResponse } = await ordersController.updateOrderItem(orderId, itemId, request);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Delete All Order Items

async deleteAllOrderItems(
  orderId: string,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order Id
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderResponse

Example Usage

const orderId = 'orderId2';
try {
  const { result, ...httpResponse } = await ordersController.deleteAllOrderItems(orderId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Update Order Metadata

Updates the metadata from an order

async updateOrderMetadata(
  orderId: string,
  request: UpdateMetadataRequest,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required The order id
request UpdateMetadataRequest Body, Required Request for updating the order metadata
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderResponse

Example Usage

const orderId = 'order_id6';
const requestMetadata: Record<string, string> = {'key0' : 'metadata3' } const request: UpdateMetadataRequest = {
  metadata: requestMetadata,
};

try {
  const { result, ...httpResponse } = await ordersController.updateOrderMetadata(orderId, request);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Delete Order Item

async deleteOrderItem(
  orderId: string,
  itemId: string,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderItemResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order Id
itemId string Template, Required Item Id
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderItemResponse

Example Usage

const orderId = 'orderId2';
const itemId = 'itemId8';
try {
  const { result, ...httpResponse } = await ordersController.deleteOrderItem(orderId, itemId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Create Order Item

async createOrderItem(
  orderId: string,
  request: CreateOrderItemRequest,
  idempotencyKey?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetOrderItemResponse>>

Parameters

Parameter Type Tags Description
orderId string Template, Required Order Id
request CreateOrderItemRequest Body, Required Order Item Model
idempotencyKey string | undefined Header, Optional -
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetOrderItemResponse

Example Usage

const orderId = 'orderId2';
const request: CreateOrderItemRequest = {
  amount: 242,
  description: 'description6',
  quantity: 100,
  category: 'category4',
};

try {
  const { result, ...httpResponse } = await ordersController.createOrderItem(orderId, request);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}