Skip to main content

Anonymize Orders

POST 
https://useast.api.elasticpath.com/v2/orders/anonymize

You can anonymize an order when it is fulfilled, canceled, or fully refunded.

When anonymization is successful, Personal Identifiable Information such as customer details, shipping_address, and billing_address are replaced with *.

Request​

Body

    data object
    order_ids string[]

    The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.

Responses​

OK

Schema
    data object
    type string

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

    order_number string

    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_ref string

    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.

    id uuid

    Specifies the unique identifier of the order.

    status string

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

    payment string

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

    shipping string

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

    anonymized boolean

    Specifies if the order is anonymized.

    meta object
    timestamps object
    created_at string

    The date this was created.

    updated_at

    The date this was last updated.

    with_tax object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    without_tax object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    tax object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    discount object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    paid object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    authorized object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    without_discount object
    amount number

    The raw total of this cart.

    currency string

    The currency set for this cart.

    formatted string

    The tax inclusive formatted total based on the currency.

    billing_address object
    company_name string

    Company name of the billing recipient.

    country stringrequired

    Specifies the country of the billing address.

    county string

    Specifies the county of the billing address.

    first_name stringrequired

    First name of the billing recipient.

    last_name stringrequired

    Last name of the billing recipient.

    line_1 stringrequired

    First line of the billing address.

    line_2 string

    Second line of the billing address.

    postcode stringrequired

    Postcode of the billing address.

    region stringrequired

    Specifies state, province, or region of the billing address.

    contact object
    email string

    The email address of the contact.

    name string

    The name of the contact.

    shipping_address object
    company_name string

    Company of the shipping recipient.

    country stringrequired

    Specifies the country of the shipping address.

    county string

    Specifies the county of the shipping address.

    first_name stringrequired

    First name of the shipping recipient.

    last_name stringrequired

    Last name of the shipping recipient.

    line_1 stringrequired

    First line of the shipping address.

    line_2 string

    Second line of the shipping address.

    postcode stringrequired

    Post code of the shipping address.

    region stringrequired

    Specifies the state, province, or region of the shipping address.

Authorization: http

name: bearerAuthtype: httpscheme: bearer
curl -L -X POST 'https://useast.api.elasticpath.com/v2/orders/anonymize' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "data": {
    "order_ids": [
      "string"
    ]
  }
}'
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Body
{
  "data": {
    "order_ids": [
      "string"
    ]
  }
}
ResponseClear

Click the Send API Request button above and see the response here!