woocommerce/packages/js/api-core-tests/endpoints/orders.js

/**
 * Internal dependencies
 */
const {
	getRequest,
	postRequest,
	putRequest,
	deleteRequest,
} = require( '../utils/request' );
const { getOrderExample, shared } = require( '../data' );

/**
 * WooCommerce Orders endpoints.
 *
 * https://woocommerce.github.io/woocommerce-rest-api-docs/#orders
 */
const ordersApi = {
	name: 'Orders',
	create: {
		name: 'Create an order',
		method: 'POST',
		path: 'orders',
		responseCode: 201,
		payload: getOrderExample(),
		order: async ( orderDetails ) => postRequest( 'orders', orderDetails ),
	},
	retrieve: {
		name: 'Retrieve an order',
		method: 'GET',
		path: 'orders/<id>',
		responseCode: 200,
		order: async ( orderId, ordersQuery = {} ) =>
			getRequest( `orders/${ orderId }`, ordersQuery ),
	},
	listAll: {
		name: 'List all orders',
		method: 'GET',
		path: 'orders',
		responseCode: 200,
		orders: async ( ordersQuery = {} ) =>
			getRequest( 'orders', ordersQuery ),
	},
	update: {
		name: 'Update an order',
		method: 'PUT',
		path: 'orders/<id>',
		responseCode: 200,
		payload: getOrderExample(),
		order: async ( orderId, orderDetails ) =>
			putRequest( `orders/${ orderId }`, orderDetails ),
	},
	delete: {
		name: 'Delete an order',
		method: 'DELETE',
		path: 'orders/<id>',
		responseCode: 200,
		payload: {
			force: false,
		},
		order: async ( orderId, deletePermanently ) =>
			deleteRequest( `orders/${ orderId }`, deletePermanently ),
	},
	batch: {
		name: 'Batch update orders',
		method: 'POST',
		path: 'orders/batch',
		responseCode: 200,
		payload: shared.getBatchPayloadExample( getOrderExample() ),
		orders: async ( batchUpdatePayload ) =>
			postRequest( `orders/batch`, batchUpdatePayload ),
	},
};

module.exports = {
	ordersApi,
};