Get Oms Meta Data

Get OMS Meta Data

GET/organizations/{organizationId}/orders/oms-meta-data

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Oms Meta Data action (under Shopper Orders).
Fill in the fields below, then reference the result from later steps as {{getOmsMetaData.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Response

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

cancelReasonCodesarray<object>

The reason codes available for cancelling an order. The server applies the reason marked with `default` when no reason is supplied on the cancel request.

reasonstringrequired

The reason value as configured in OMS.

defaultbooleanrequired

Whether this reason is the default that the server uses when no reason is supplied on a cancel or return request.

returnReasonCodesarray<object>

The reason codes available for returning order items. The server applies the reason marked with `default` when no reason is supplied on a returned item.

reasonstringrequired

The reason value as configured in OMS.

defaultbooleanrequired

Whether this reason is the default that the server uses when no reason is supplied on a cancel or return request.

json

{
  "cancelReasonCodes": [
    {
      "reason": "Defect",
      "default": false
    }
  ],
  "returnReasonCodes": [
    {
      "reason": "Defect",
      "default": false
    }
  ]
}

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

Was this page helpful?