younifyd
Menu

Batch Orders

Batch create, update, and delete orders

POST/orders/batch

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the Batch Orders action (under Orders).
  3. Fill in the fields below, then reference the result from later steps as {{batchOrders.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

createarray<object>
idinteger

Unique identifier for the resource.

parent_idinteger

Parent order ID.

numberstring

Order number.

order_keystring

Order key.

created_viastring

Shows where the order was created.

versionstring

Version of WooCommerce which last updated the order.

statusstring

Order status. Options - pending, processing, on-hold, completed, cancelled, refunded, failed, trash and checkout-draft. Default is pending.

currencystring

Currency the order was created with, in ISO format.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

date_createdstring (date-time)

The date the order was created, in the site's timezone.

date_created_gmtstring (date-time)

The date the order was created, as GMT.

date_modifiedstring (date-time)

The date the order was last modified, in the site's timezone.

date_modified_gmtstring (date-time)

The date the order was last modified, as GMT.

discount_totalstring

Total discount amount for the order.

discount_taxstring

Total discount tax amount for the order.

shipping_totalstring

Total shipping amount for the order.

shipping_taxstring

Total shipping tax amount for the order.

cart_taxstring

Sum of line item taxes only.

totalstring

Grand total.

total_taxstring

Sum of all taxes.

prices_include_taxboolean

True the prices included tax during checkout.

customer_idinteger

User ID who owns the order. 0 for guests.

customer_ip_addressstring

Customer's IP address.

customer_user_agentstring

User agent of the customer.

customer_notestring

Note left by customer during checkout.

billingobject11 fields
shippingobject10 fields
payment_methodstring

Payment method ID.

payment_method_titlestring

Payment method title.

transaction_idstring

Unique transaction ID.

date_paidstring (date-time)

The date the order was paid, in the site's timezone.

date_paid_gmtstring (date-time)

The date the order was paid, as GMT.

date_completedstring (date-time)

The date the order was completed, in the site's timezone.

date_completed_gmtstring (date-time)

The date the order was completed, as GMT.

cart_hashstring

MD5 hash of cart items to ensure orders are not modified.

meta_dataarray<object>5 fields

Meta data properties.

line_itemsarray<object>15 fields

Line items data.

tax_linesarray<object>8 fields

Tax lines data.

shipping_linesarray<object>8 fields

Shipping lines data.

fee_linesarray<object>8 fields

Fee lines data.

coupon_linesarray<object>5 fields

Fee lines data.

updatearray<object>
idinteger

Unique identifier for the resource.

parent_idinteger

Parent order ID.

numberstring

Order number.

order_keystring

Order key.

created_viastring

Shows where the order was created.

versionstring

Version of WooCommerce which last updated the order.

statusstring

Order status. Options - pending, processing, on-hold, completed, cancelled, refunded, failed, trash and checkout-draft. Default is pending.

currencystring

Currency the order was created with, in ISO format.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

date_createdstring (date-time)

The date the order was created, in the site's timezone.

date_created_gmtstring (date-time)

The date the order was created, as GMT.

date_modifiedstring (date-time)

The date the order was last modified, in the site's timezone.

date_modified_gmtstring (date-time)

The date the order was last modified, as GMT.

discount_totalstring

Total discount amount for the order.

discount_taxstring

Total discount tax amount for the order.

shipping_totalstring

Total shipping amount for the order.

shipping_taxstring

Total shipping tax amount for the order.

cart_taxstring

Sum of line item taxes only.

totalstring

Grand total.

total_taxstring

Sum of all taxes.

prices_include_taxboolean

True the prices included tax during checkout.

customer_idinteger

User ID who owns the order. 0 for guests.

customer_ip_addressstring

Customer's IP address.

customer_user_agentstring

User agent of the customer.

customer_notestring

Note left by customer during checkout.

billingobject11 fields
shippingobject10 fields
payment_methodstring

Payment method ID.

payment_method_titlestring

Payment method title.

transaction_idstring

Unique transaction ID.

date_paidstring (date-time)

The date the order was paid, in the site's timezone.

date_paid_gmtstring (date-time)

The date the order was paid, as GMT.

date_completedstring (date-time)

The date the order was completed, in the site's timezone.

date_completed_gmtstring (date-time)

The date the order was completed, as GMT.

cart_hashstring

MD5 hash of cart items to ensure orders are not modified.

meta_dataarray<object>5 fields

Meta data properties.

line_itemsarray<object>15 fields

Line items data.

tax_linesarray<object>8 fields

Tax lines data.

shipping_linesarray<object>8 fields

Shipping lines data.

fee_linesarray<object>8 fields

Fee lines data.

coupon_linesarray<object>5 fields

Fee lines data.

deletearray<integer>
json
{
  "create": [
    {
      "id": 0,
      "parent_id": 0,
      "number": "string",
      "order_key": "string",
      "created_via": "string",
      "version": "string",
      "status": "string",
      "currency": "AED",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z"
    }
  ],
  "update": [
    {
      "id": 0,
      "parent_id": 0,
      "number": "string",
      "order_key": "string",
      "created_via": "string",
      "version": "string",
      "status": "string",
      "currency": "AED",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z"
    }
  ],
  "delete": [
    0
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{batchOrders.response.data.<field>}}.

createarray<object>
idinteger

Unique identifier for the resource.

parent_idinteger

Parent order ID.

numberstring

Order number.

order_keystring

Order key.

created_viastring

Shows where the order was created.

versionstring

Version of WooCommerce which last updated the order.

statusstring

Order status. Options - pending, processing, on-hold, completed, cancelled, refunded, failed, trash and checkout-draft. Default is pending.

currencystring

Currency the order was created with, in ISO format.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

date_createdstring (date-time)

The date the order was created, in the site's timezone.

date_created_gmtstring (date-time)

The date the order was created, as GMT.

date_modifiedstring (date-time)

The date the order was last modified, in the site's timezone.

date_modified_gmtstring (date-time)

The date the order was last modified, as GMT.

discount_totalstring

Total discount amount for the order.

discount_taxstring

Total discount tax amount for the order.

shipping_totalstring

Total shipping amount for the order.

shipping_taxstring

Total shipping tax amount for the order.

cart_taxstring

Sum of line item taxes only.

totalstring

Grand total.

total_taxstring

Sum of all taxes.

prices_include_taxboolean

True the prices included tax during checkout.

customer_idinteger

User ID who owns the order. 0 for guests.

customer_ip_addressstring

Customer's IP address.

customer_user_agentstring

User agent of the customer.

customer_notestring

Note left by customer during checkout.

billingobject11 fields
shippingobject10 fields
payment_methodstring

Payment method ID.

payment_method_titlestring

Payment method title.

transaction_idstring

Unique transaction ID.

date_paidstring (date-time)

The date the order was paid, in the site's timezone.

date_paid_gmtstring (date-time)

The date the order was paid, as GMT.

date_completedstring (date-time)

The date the order was completed, in the site's timezone.

date_completed_gmtstring (date-time)

The date the order was completed, as GMT.

cart_hashstring

MD5 hash of cart items to ensure orders are not modified.

meta_dataarray<object>5 fields

Meta data properties.

line_itemsarray<object>15 fields

Line items data.

tax_linesarray<object>8 fields

Tax lines data.

shipping_linesarray<object>8 fields

Shipping lines data.

fee_linesarray<object>8 fields

Fee lines data.

coupon_linesarray<object>5 fields

Fee lines data.

updatearray<object>
idinteger

Unique identifier for the resource.

parent_idinteger

Parent order ID.

numberstring

Order number.

order_keystring

Order key.

created_viastring

Shows where the order was created.

versionstring

Version of WooCommerce which last updated the order.

statusstring

Order status. Options - pending, processing, on-hold, completed, cancelled, refunded, failed, trash and checkout-draft. Default is pending.

currencystring

Currency the order was created with, in ISO format.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

date_createdstring (date-time)

The date the order was created, in the site's timezone.

date_created_gmtstring (date-time)

The date the order was created, as GMT.

date_modifiedstring (date-time)

The date the order was last modified, in the site's timezone.

date_modified_gmtstring (date-time)

The date the order was last modified, as GMT.

discount_totalstring

Total discount amount for the order.

discount_taxstring

Total discount tax amount for the order.

shipping_totalstring

Total shipping amount for the order.

shipping_taxstring

Total shipping tax amount for the order.

cart_taxstring

Sum of line item taxes only.

totalstring

Grand total.

total_taxstring

Sum of all taxes.

prices_include_taxboolean

True the prices included tax during checkout.

customer_idinteger

User ID who owns the order. 0 for guests.

customer_ip_addressstring

Customer's IP address.

customer_user_agentstring

User agent of the customer.

customer_notestring

Note left by customer during checkout.

billingobject11 fields
shippingobject10 fields
payment_methodstring

Payment method ID.

payment_method_titlestring

Payment method title.

transaction_idstring

Unique transaction ID.

date_paidstring (date-time)

The date the order was paid, in the site's timezone.

date_paid_gmtstring (date-time)

The date the order was paid, as GMT.

date_completedstring (date-time)

The date the order was completed, in the site's timezone.

date_completed_gmtstring (date-time)

The date the order was completed, as GMT.

cart_hashstring

MD5 hash of cart items to ensure orders are not modified.

meta_dataarray<object>5 fields

Meta data properties.

line_itemsarray<object>15 fields

Line items data.

tax_linesarray<object>8 fields

Tax lines data.

shipping_linesarray<object>8 fields

Shipping lines data.

fee_linesarray<object>8 fields

Fee lines data.

coupon_linesarray<object>5 fields

Fee lines data.

deletearray<object>
idinteger

Unique identifier for the resource.

parent_idinteger

Parent order ID.

numberstring

Order number.

order_keystring

Order key.

created_viastring

Shows where the order was created.

versionstring

Version of WooCommerce which last updated the order.

statusstring

Order status. Options - pending, processing, on-hold, completed, cancelled, refunded, failed, trash and checkout-draft. Default is pending.

currencystring

Currency the order was created with, in ISO format.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTCBTNBWPBYRBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKK

date_createdstring (date-time)

The date the order was created, in the site's timezone.

date_created_gmtstring (date-time)

The date the order was created, as GMT.

date_modifiedstring (date-time)

The date the order was last modified, in the site's timezone.

date_modified_gmtstring (date-time)

The date the order was last modified, as GMT.

discount_totalstring

Total discount amount for the order.

discount_taxstring

Total discount tax amount for the order.

shipping_totalstring

Total shipping amount for the order.

shipping_taxstring

Total shipping tax amount for the order.

cart_taxstring

Sum of line item taxes only.

totalstring

Grand total.

total_taxstring

Sum of all taxes.

prices_include_taxboolean

True the prices included tax during checkout.

customer_idinteger

User ID who owns the order. 0 for guests.

customer_ip_addressstring

Customer's IP address.

customer_user_agentstring

User agent of the customer.

customer_notestring

Note left by customer during checkout.

billingobject11 fields
shippingobject10 fields
payment_methodstring

Payment method ID.

payment_method_titlestring

Payment method title.

transaction_idstring

Unique transaction ID.

date_paidstring (date-time)

The date the order was paid, in the site's timezone.

date_paid_gmtstring (date-time)

The date the order was paid, as GMT.

date_completedstring (date-time)

The date the order was completed, in the site's timezone.

date_completed_gmtstring (date-time)

The date the order was completed, as GMT.

cart_hashstring

MD5 hash of cart items to ensure orders are not modified.

meta_dataarray<object>5 fields

Meta data properties.

line_itemsarray<object>15 fields

Line items data.

tax_linesarray<object>8 fields

Tax lines data.

shipping_linesarray<object>8 fields

Shipping lines data.

fee_linesarray<object>8 fields

Fee lines data.

coupon_linesarray<object>5 fields

Fee lines data.

json
{
  "create": [
    {
      "id": 0,
      "parent_id": 0,
      "number": "string",
      "order_key": "string",
      "created_via": "string",
      "version": "string",
      "status": "string",
      "currency": "AED",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z"
    }
  ],
  "update": [
    {
      "id": 0,
      "parent_id": 0,
      "number": "string",
      "order_key": "string",
      "created_via": "string",
      "version": "string",
      "status": "string",
      "currency": "AED",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z"
    }
  ],
  "delete": [
    {
      "id": 0,
      "parent_id": 0,
      "number": "string",
      "order_key": "string",
      "created_via": "string",
      "version": "string",
      "status": "string",
      "currency": "AED",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.