Atributos do Shopify

Prev Next

Este guia contém uma lista dos atributos do Shopify que são coletados automaticamente pela Integração com o Shopify.

Atributo

Formato de valor

legacyResourceId

Identificador de cliente do Shopify.

  • Número*. Exemplo: 4435209126053.

acceptsMarketing

Se o cliente consentiu em receber material de marketing por e-mail.

  • Número*. Exemplo:0

acceptsMarketingUpdatedAt

A data e hora (formato ISO 8601) em que o cliente consentiu ou se opôs ao recebimento de material de marketing por e-mail.

  • Encontro*. Exemplo: 2021-02-02T10:23:58Z.

addresses

Uma lista dos dez endereços mais recentemente atualizados do cliente.

averageOrderAmountV2

O valor médio que o cliente gastou por pedido.

  • Array*. Exemplo:

    {
      "amount": "0.00",
      "currencyCode": "EUR"
    }

canDelete

Se o comerciante pode excluir o cliente da loja.

  • Exemplo: número.*1

createdAt

A data e hora (formato ISO 8601) em que o cliente foi criado.

  • Encontro*. Exemplo: 2021-02-02T10:23:58Z

defaultAddress

O endereço padrão do cliente. Mesmas propriedades do endereço.

displayName

O nome completo do cliente, baseado nos valores para first_name e last_name. Se esses valores não estiverem disponíveis, isso volta ao endereço de e-mail do cliente e, se não estiver disponível, ao número de telefone do cliente.

  • Fio*. Exemplo: John Doe

email

O endereço de e-mail único do cliente.

  • Fio*. Exemplo: [email protected]

firstName

O primeiro nome do cliente.

  • Fio*. Exemplo:John

lastName

O sobrenome do cliente.

  • Fio*. Exemplo:Doe

hasNote

Se o cliente tem uma nota associada a ele.

  • Exemplo:0

hasTimelineComment

Se o comerciante adicionou comentários na linha do tempo sobre o cliente na página do cliente.

  • Exemplo:0

lifetimeDuration

O tempo desde que o cliente foi adicionado à loja pela primeira vez.

  • Fio*. Exemplo: about 1 month

locale

A linguagem do cliente.

  • Fio*. Exemplo:en

marketingOptInLevel

A opção de assinatura de marketing que o cliente forneceu ao concordar em receber material de marketing por e-mail.

  • Número*.

note

Uma nota sobre o cliente.

  • Fio*. Exemplo: Repeating customer

ordersCount

O número de pedidos associados a esse cliente.

  • Exemplo: 14

lastOrder

Última informação do pedido do cliente.
Veja o objeto de última ordem para uma descrição detalhada de cada propriedade.

state

O estado da conta do cliente em uma loja. Valor padrão: disabled.

  • Fio*. Valores válidos:

disabled: O cliente não tem uma conta ativa. Contas de clientes podem ser desativadas no administrador do Shopify a qualquer momento.
invited: O cliente recebeu um convite por e-mail para criar uma conta.
enabled: O cliente criou uma conta.
declined: O cliente recusou o convite por e-mail para criar uma conta.

tags

Tags que o dono da loja anexou ao cliente, formatadas como uma sequência de valores separados por vírgulas.

  • Array*. Exemplo: [example1,example2]

taxExempt

Se o cliente está isento de pagar impostos sobre seu pedido. Se 1, então os impostos não serão aplicados a um pedido no checkout. Se 0, então os impostos serão aplicados no checkout.

  • Exemplo:0

taxExemptions

Se o cliente está isento de pagar impostos específicos sobre o pedido. Apenas impostos canadenses. Veja a documentação do Shopify para valores válidos (abaixo de tax_exemptions).

  • Array*. Exemplo:

    [
      "CA_STATUS_CARD_EXEMPTION",
      "CA_BC_RESELLER_EXEMPTION"
    ]

totalSpent

O valor total que o cliente gastou ao longo do histórico de pedidos.

  • Número*. Exemplo: 50.76

totalSpentV2

O valor total de dinheiro com moeda que o cliente gastou ao longo do histórico de pedidos.

  • Array*. Exemplo:

    {
      "amount": "0.00",
      "currencyCode": "EUR"
    }

updatedAt

A data e hora (formato ISO 8601) em que as informações do cliente foram atualizadas pela última vez.

  • Encontro*. Exemplo: 2021-02-12T12:36:03Z

validEmailAddress

Se o endereço de e-mail é válido.

  • Número*. Exemplo:1

verifiedEmail

Se o cliente verificou seu endereço de e-mail.

  • Número*. Exemplo:1

Objeto de endereçamento

Uma lista dos dez endereços mais recentemente atualizados do cliente. Cada endereço possui as seguintes propriedades:

Propriedade

Descrição

address1

O endereço postal do cliente.
Exemplo:Sunset Blvd, 92

address2

Um campo adicional para o endereço do cliente.
Exemplo: Apt. 2

city

A cidade, vila ou vila do cliente.
Exemplo: Louisville

company

A empresa do cliente.
Exemplo: Clara Enterprises Inc.

country

O país do cliente.
Exemplo: US

country_code

Código de país de duas letras correspondente ao país do cliente.
Exemplo: US

country_name

O nome normalizado do país do cliente.
Exemplo: United States

customer_id

Um identificador único para o cliente.
Exemplo: 6940095564

default

Se esse endereço é o padrão do cliente. Booleano.
Exemplo: true

first_name

O primeiro nome do cliente.
Exemplo: Clara

id

Um identificador único para o endereço.
Exemplo: 207119551

last_name

O sobrenome do cliente.
Exemplo: Norman

name

O primeiro e sobrenome do cliente.
Exemplo: Clara Norman

phone

O número de telefone do cliente neste endereço.
Exemplo: 555-625-1199

province

O nome da região do cliente. Tipicamente uma província, um estado ou uma prefeitura.
Exemplo: Kentucky

province_code

O código para a região do endereço, como província, estado ou distrito. Por exemplo QC , para Quebec, Canadá.

zip

O código postal do cliente, também conhecido como CEP, CEP, Eircode, etc.
Exemplo: 40202

Exemplo:

{
    "id": 207119551,
    "customer_id": 6940095564,
    "first_name": "Clara",
    "last_name": "Norman",
    "company": null,
    "address1": "Sunset Blvd, 92",
    "address2": "Apt. 2",
    "city": "Louisville",
    "province": "Kentucky",
    "country": "US",
    "zip": "40202",
    "phone": "555-625-1199",
    "province_code": "KY",
    "country_code": "US",
    "country_name": "United States",
    "default": true
}

Objeto de última ordem

Última informação do pedido do cliente. Possui as seguintes propriedades:

Propriedade

Descrição

id

Um ID único para o cliente
Exemplo: gid://shopify/Order/3744530170021

cancelReason

Motivo do cancelamento do pedido. Devolução null se o pedido não foi cancelado.
Exemplo: declined

cancelledAt

Data e hora do cancelamento do pedido. Devolução null se o pedido não foi cancelado.
Exemplo: 2021-05-15T13:04:22Z

cartDiscountAmountSet

Valor do desconto em nível de pedido (não contém descontos por itens de linha) em moedas de loja e de apresentação.
Exemplo: 29.99

closed

Se a ordem está encerrada. Booleano.
Exemplo: false

closedAt

Data e hora em que o pedido foi fechado. Se a ordem não for fechada, então esse corpo é null.
Exemplo: 2021-05-15T16:05:11Z

confirmed

Se o estoque foi reservado para o pedido. Booleano.
Exemplo: true

createdAt

Data e hora em que o pedido foi criado no Shopify
Exemplo: 2021-04-15T13:59:31Z

currentSubtotalLineItemsQuantity

A soma das quantidades dos itens que contribuem para o subtotal do pedido.
Exemplo: 1

currentSubtotalPriceSet

O subtotal de itens e seus descontos menos os itens que foram devolvidos. Isso inclui descontos em nível de ordem, a menos que o argumento with_cart_discount esteja configurado como falso. Isso não inclui custos de frete e descontos no envio. Os impostos não são incluídos, a menos que a ordem seja incluída em impostos. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  },
  "shopMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }
}

currentTotalDiscountsSet

O valor total descontado do pedido (incluindo descontos em nível de pedido e itens de linha) menos os valores dos itens devolvidos. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }
}

currentTotalPriceSet

O valor total do pedido (incluindo impostos e descontos) menos os valores dos itens devolvidos. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }
}

displayFulfillmentStatus

Status de cumprimento do pedido que pode ser mostrado ao comerciante. Esse campo não captura todos os detalhes possíveis do estado de cumprimento de um pedido. Deve ser usado apenas para fins de resumo de exibição.
Exemplo: UNFULFILLED

totalDiscountsSet

Valor total descontado do pedido (incluindo descontos em nível de pedido e itens de linha) em moedas de loja e de apresentação. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }

totalPriceSet

Valor total do pedido (incluindo impostos e descontos) em moedas de loja e de apresentação. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }

totalRefundedSet

Valor total reembolsado pelo pedido em moedas de loja e apresentação. Exemplo:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  },
  "shopMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }
}

Exemplo:

{
    "id": "gid://shopify/Order/3744530170021",
    "cancelReason": null,
    "cancelledAt": null,
    "cartDiscountAmountSet": null,
    "closed": false,
    "closedAt": null,
    "confirmed": true,
    "createdAt": "2021-04-15T13:59:31Z",
    "currentSubtotalLineItemsQuantity": 1,
    "currentSubtotalPriceSet": {
        "presentmentMoney": {
            "amount": "0.5",
            "currencyCode": "EUR"
        },
        "shopMoney": {
            "amount": "0.5",
            "currencyCode": "EUR"
        }
    },
    "currentTotalDiscountsSet": {
        "presentmentMoney": {
            "amount": "0.0",
            "currencyCode": "EUR"
        }
    },
    "currentTotalPriceSet": {
        "presentmentMoney": {
            "amount": "0.5",
            "currencyCode": "EUR"
        }
    },
    "displayFulfillmentStatus": "UNFULFILLED",
    "edited": false,
    "email": "[email protected]",
    "fulfillable": true,
    "phone": null,
    "shippingAddress": null,
    "totalDiscountsSet": {
        "presentmentMoney": {
            "amount": "0.0",
            "currencyCode": "EUR"
        },
        "shopMoney": {
            "amount": "0.0",
            "currencyCode": "EUR"
        }
    },
    "totalPriceSet": {
        "presentmentMoney": {
            "amount": "0.5",
            "currencyCode": "EUR"
        },
        "shopMoney": {
            "amount": "0.5",
            "currencyCode": "EUR"
        }
    },
    "totalRefundedSet": {
        "presentmentMoney": {
            "amount": "0.0",
            "currencyCode": "EUR"
        },
        "shopMoney": {
            "amount": "0.0",
            "currencyCode": "EUR"
        }
    }
}

As informações nesta página são resumidas da documentação do Shopify.