Batch metafields
Get All Order Metafields
GET https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafieldsRequest
Get all order metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
List of Metafield
objects.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[]
example
Create multiple Metafields
POST https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafieldsRequest
Create multiple metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
array | application/json
example
Response
List of created Metafield
objects.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[]
errorsarray[]
Empty for 200 responses.
Example: []
example
Update multiple Metafields
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafieldsRequest
Update multiple metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
array | application/json
example
Response
List of updated Metafield
objects.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[]
errorsarray[]
Empty for 200 responses.
Example: []
example
Delete Multiple Metafields
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafieldsRequest
Delete all order metafields.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
List of metafield IDs.
Body
array | application/json
example
Response
Response object for metafields deletion with success.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[integer]
Type: array[integer]Example: [123,124,125]errorsarray[]
Empty for 200 responses.
Example: []
example
Did you find what you were looking for?