younifyd
Menu

Anonymize Orders

Anonymize Orders

POST/v2/orders/anonymize

Use it in a workflow

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

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://useast.api.elasticpath.comhttps://euwest.api.elasticpath.com__custom__Default "https://useast.api.elasticpath.com"

baseUrlCustomstring
bodystring

The request body content (for POST, PUT, PATCH requests).

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

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

dataarray<object>
typestring

Specifies the type of object being returned. You must use `order`.

order_numberstring

Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.

external_refstring

An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.

idstring (uuid)

Specifies the unique identifier of the order.

statusstring

Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.

One ofcompleteincompletecancelledprocessing

paymentstring

Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.

One ofauthorizedpaidunpaidrefundedpartially_paidpartially_authorized

shippingstring

Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.

One ofunfulfilledfulfilled

anonymizedboolean

Specifies if the order is anonymized.

payment_intent_idstring

Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.

custom_attributesobject

Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types. Example: ``` "custom_attributes": { "is_member": { "type": "boolean", "value": true }, "membership_level": { "type": "string", "value": "premium" } } ```

linksobject
metaobject3 fields
billing_addressoneOf

Billing address information. You must specify at least one of region (state/province) or county.

contactobject2 fields
customerobject3 fields
shipping_addressany

Shipping address information. You must specify at least one of region (state/province) or county.

relationshipsobject7 fields
json
{
  "data": [
    {
      "type": "string",
      "order_number": "string",
      "external_ref": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "complete",
      "payment": "authorized",
      "shipping": "unfulfilled",
      "anonymized": false,
      "payment_intent_id": "string",
      "custom_attributes": {},
      "links": {},
      "meta": {
        "timestamps": {
          "created_at": "string",
          "updated_at": "string",
          "fully_paid_at": "string"
        },
        "display_price": {
          "with_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "balance_owing": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "paid": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "authorized": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "shipping": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "shipping_discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          }
        },
        "is_manual": false
      }
    }
  ]
}

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