Sign in
Order Metafields

Create specific metafield

To create metafield attached to specific order by metafield ID

post/orders/{order_id}/metafields

Path parameters

order_idstring required

Order ID

Request body

namespaceNamespace — unresolved $ref
keyKey — unresolved $ref
field_typeFieldType — unresolved $ref
field_valueFieldValue — unresolved $ref

Response

OK

idstring

Metafield Value ID

namespacestring

Namespace

keystring

Key

field_type'single_line_text_field' | 'multi_line_text_field' | 'number_integer' | 'number_decimal' | 'json' | 'boolean' | 'url'

Data type of the metafield value<br> Type allows:<br> single_line_text_field - One line of string (max 50 characters)<br> multi_line_text_field - Multiple line of string (max 1000 characters)<br> number_integer - Integer<br> number_decimal - Decimal<br> json - String of JSON object (max 4000 characters)<br> boolean - Boolean<br> url - String of URL<br>

created_atstring
updated_atstring
metafield_type'merchant' | 'app'

Type of the metafield

resource_idstring

Resource ID

resource_type'merchant' | 'customer' | 'product' | 'order' | 'order_item' | 'cart_item'

Resource Type

merchant_idstring

Merchant ID

Example response

{
  "id": "5ad86757e38809441400001b",
  "namespace": "sales",
  "key": "discount",
  "field_type": "number_integer",
  "field_value": 10,
  "created_at": "2021-12-01T03:12:11.666+00:00",
  "updated_at": "2021-12-02T09:35:12.555+00:00",
  "metafield_type": "merchant",
  "resource_id": "62f9f0c76f4ae6001e4b00f2",
  "resource_type": "product",
  "merchant_id": "66418472bcba497f92f3a168"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.