Shopify (publicador independiente) (versión preliminar)
Interfaz REST para que los comerciantes de Shopify reciban, procesen y administren sus pedidos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| Correo Electrónico | bennettray@microsoft.com |
| Metadatos del conector | |
|---|---|
| Publicador | Ray Cox (MSFT) |
| Website | https://www.shopify.com/ |
| Directiva de privacidad | https://www.shopify.com/legal/privacy |
| Categorías | Productividad |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | securestring | Token de acceso para esta API. | Cierto |
| Dirección URL de la tienda | cuerda / cadena | Dirección URL de la tienda Shopify | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualiza un pedido |
Actualiza un pedido con la información proporcionada. |
| Cancelar un pedido |
Cancelar un pedido por identificador. |
| Recupera una lista de clientes |
Recupera una lista de clientes que cumplen los criterios especificados. |
| Recupera una lista de pedidos |
Recupera una lista de pedidos que cumplen los criterios especificados. |
Actualiza un pedido
Actualiza un pedido con la información proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de pedido
|
order_id | True | string |
Identificador del orden que se actualizará. |
|
|
object |
Devoluciones
Pedido
- Body
- order
Cancelar un pedido
Cancelar un pedido por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de pedido
|
order_id | True | string |
Id. del pedido que se cancelará. |
|
Reembolso El importe real
|
amount | string |
Importe que se va a reembolsar. Si se establece, Shopify intenta anular o reembolsar el pago, dependiendo de su estado. Shopify reembolsos a través de una puerta de enlace manual en los casos en los que la transacción original no se realizó en Shopify. Los reembolsos a través de una puerta de enlace manual se registran como un reembolso en Shopify, pero el cliente no se reembolsará. |
|
|
Moneda de reembolso
|
currency | string |
Moneda del reembolso que se emite cuando se cancela el pedido. Se requiere para pedidos de varias monedas siempre que se proporcione la propiedad amount. |
|
|
Artículos devueltos de reposición
|
restock | string |
Indica si hay que volver a cargar los artículos devueltos al inventario de la tienda. |
|
|
Motivo de cancelación del pedido
|
reason | string |
Motivo de la cancelación del pedido. Valores válidos: cliente, inventario, fraude, rechazado y otros. |
|
|
Correo electrónico de cancelación
|
string |
Si se debe enviar un correo electrónico al cliente para notificarles la cancelación. |
||
|
Reembolso
|
refund | string |
Las transacciones de reembolso que se van a realizar. |
|
|
|
object |
Devoluciones
Pedido
- Body
- order
Recupera una lista de clientes
Recupera una lista de clientes que cumplen los criterios especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de cliente
|
ids | string |
Restrinja los resultados a los clientes especificados por una lista separada por comas de identificadores. |
|
|
Desde el identificador
|
since_id | string |
Restrinja los resultados después del identificador especificado. |
|
|
Creado en minutos
|
created_at_min | string |
Mostrar los clientes creados después de una fecha especificada (formato: 2014-04-25T16:15:47-04:00). |
|
|
Creado al máximo
|
created_at_max | string |
Mostrar los clientes creados antes de una fecha especificada (formato: 2014-04-25T16:15:47-04:00). |
|
|
Actualizado al menos
|
updated_at_min | string |
Mostrar a los clientes la última actualización después de una fecha especificada (formato: 2014-04-25T16:15:47-04:00). |
|
|
Actualizado al máximo
|
updated_at_max | string |
Mostrar a los clientes por última vez actualizados antes de una fecha especificada (formato: 2014-04-25T16:15:47-04:00). |
|
|
Limit
|
limit | string |
Número máximo de resultados que se van a mostrar. (valor predeterminado: 50)(máximo: 250). |
|
|
Fields
|
fields | string |
Mostrar solo determinados campos, especificados por una lista separada por comas de campos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
customers
|
customers | array of customer |
Recupera una lista de pedidos
Recupera una lista de pedidos que cumplen los criterios especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de pedido
|
ids | string |
Recupere solo los pedidos especificados por una lista separada por comas de identificadores de pedido. |
|
|
Limit
|
limit | string |
Número máximo de resultados que se van a mostrar en una página. |
|
|
Desde el identificador
|
since_id | string |
Mostrar pedidos después del identificador especificado. |
|
|
Creado en minutos
|
created_at_min | string |
Mostrar pedidos creados a la fecha o posterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Creado al máximo
|
created_at_max | string |
Mostrar pedidos creados a la fecha o anterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Actualizado al menos
|
updated_at_min | string |
Mostrar los pedidos actualizados por última vez a la fecha o posterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Actualizado al máximo
|
updated_at_max | string |
Mostrar pedidos actualizados por última vez a la fecha o anterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Procesado en minutos
|
processed_at_min | string |
Mostrar pedidos importados a fecha o posterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Procesado al máximo
|
processed_at_max | string |
Mostrar pedidos importados a fecha o anterior (formato: 2014-04-25T16:15:47-04:00). |
|
|
Id. de aplicación de atribución
|
attribution_app_id | string |
Muestra los pedidos asignados a una determinada aplicación, especificada por el identificador de la aplicación. |
|
|
Estado del pedido
|
status | string |
Filtre los pedidos por su estado. |
|
|
Estado financiero
|
financial_status | string |
Filtre los pedidos por su estado financiero. |
|
|
Estado de cumplimiento
|
fulfillment_status | string |
Filtre los pedidos por su estado de cumplimiento. |
|
|
Fields
|
fields | string |
Recupere solo determinados campos, especificados por una lista separada por comas de campos. |
|
|
Orden de secuencia de registros
|
order | string |
Campo y dirección para ordenar los pedidos. Para especificar la dirección, agregue " asc" o " desc" al final del parámetro de consulta. Por ejemplo, 'order=updated_at asc'. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
orders
|
orders | array of order |
Definiciones
order
Pedido
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador de la aplicación que creó el pedido. |
|
Correo electrónico
|
string |
Dirección de correo electrónico del cliente. |
|
|
closed_at
|
closed_at | string |
Fecha y hora (formato ISO 8601) cuando se cerró el pedido. Devuelve NULL si el orden no está cerrado. |
|
fecha_de_creación
|
created_at | string |
El código de tres letras (formato ISO 4217) para la moneda de la tienda. |
|
updated_at
|
updated_at | string |
Fecha y hora (formato ISO 8601) cuando se modificó por última vez el pedido. |
|
number
|
number | integer |
La posición del pedido en el recuento de pedidos de la tienda. Los números son secuenciales y comienzan en 1. |
|
nota
|
note | string |
Una nota opcional que un propietario de la tienda puede adjuntar al pedido. |
|
token
|
token | string |
Valor único al hacer referencia al orden. |
|
puerta de enlace
|
gateway | string |
Puerta de enlace de pago usada. |
|
test
|
test | boolean |
Si se trata de un pedido de prueba. |
|
total_price
|
total_price | string |
La suma de todos los precios de artículos de línea, descuentos, envío, impuestos y propinas en la moneda de la tienda. Debe ser positivo. |
|
subtotal_price
|
subtotal_price | string |
El precio del pedido en la moneda de la tienda después de descuentos pero antes del envío, derechos, impuestos y propinas. |
|
total_weight
|
total_weight | integer |
Suma de todos los pesos de los elementos de línea en gramos. La suma no se ajusta a medida que se quitan los elementos del pedido. |
|
total_tax
|
total_tax | string |
La suma de todos los impuestos aplicados al pedido en la moneda de la tienda. Debe ser positivo. |
|
taxes_included
|
taxes_included | boolean |
Si los impuestos se incluyen en el subtotal del pedido. |
|
divisa
|
currency | string |
El código de tres letras (formato ISO 4217) para la moneda de la tienda. |
|
financial_status
|
financial_status | string |
Estado de los pagos asociados al pedido. Solo se puede establecer cuando se crea el pedido. |
|
empedernido
|
confirmed | boolean |
Pedido confirmado. |
|
total_discounts
|
total_discounts | string |
Los descuentos totales aplicados al precio del pedido en la moneda de la tienda. |
|
total_line_items_price
|
total_line_items_price | string |
La suma de todos los precios de artículos de línea en la moneda de la tienda. |
|
cart_token
|
cart_token | string |
Valor único al hacer referencia al carro asociado al pedido. |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
Si el cliente consiente recibir actualizaciones por correo electrónico de la tienda. |
|
nombre
|
name | string |
El nombre del pedido, generado mediante la combinación de la propiedad order_number con el prefijo de pedido y el sufijo que se establecen en la configuración general del comerciante. |
|
referring_site
|
referring_site | string |
El sitio web donde el cliente ha clic en un vínculo a la tienda. |
|
landing_site
|
landing_site | string |
Dirección URL de la página donde el comprador aterrizó cuando entraron en la tienda. |
|
fecha_de_cancelación
|
cancelled_at | string |
Fecha y hora en que se canceló el pedido. Devuelve null si el orden no se cancela. |
|
cancel_reason
|
cancel_reason | string |
Motivo por el que se canceló el pedido. |
|
total_price_usd
|
total_price_usd | string |
Precio total usd. |
|
checkout_token
|
checkout_token | string |
Valor único al hacer referencia a la desprotección asociada al pedido. |
|
referencia
|
reference | string |
Referencia de pedido. |
|
user_id
|
user_id | integer |
El identificador del usuario que inició sesión en Shopify POS que procesó el pedido, si procede. |
|
location_id
|
location_id | integer |
Identificador de la ubicación física donde se procesó el pedido. Si necesita hacer referencia a la ubicación en un pedido, use el recurso FulfillmentOrder. |
|
source_identifier
|
source_identifier | string |
Identificador de origen. |
|
source_url
|
source_url | string |
Dirección URL de origen. |
|
processed_at
|
processed_at | string |
Fecha y hora (formato ISO 8601) cuando se procesó un pedido. |
|
device_id
|
device_id | string |
Identificador del dispositivo. |
|
phone
|
phone | string |
Número de teléfono del cliente para recibir notificaciones por SMS. |
|
customer_locale
|
customer_locale | string |
El código de lenguaje de dos o tres letras, seguido opcionalmente por un modificador de región. |
|
app_id
|
app_id | integer |
Identificador de la aplicación que creó el pedido. |
|
browser_ip
|
browser_ip | string |
Dirección IP del explorador utilizado por el cliente cuando realizó el pedido. |
|
landing_site_ref
|
landing_site_ref | string |
Referencia del sitio de aterrizaje. |
|
order_number
|
order_number | integer |
La posición del pedido en el recuento de pedidos de la tienda a partir de 1001. |
|
discount_applications
|
discount_applications | discount_applications |
Descripción de la aplicación de descuento, tal como se define por el comerciante o el Script shopify. |
|
discount_codes
|
discount_codes | discount_codes |
Lista de descuentos aplicados al pedido. |
|
note_attributes
|
note_attributes | note_attributes |
Información adicional que se agrega al pedido. |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
Lista de puertas de enlace de pago usadas para el pedido. |
|
processing_method
|
processing_method | string |
Cómo se procesó el pago. |
|
checkout_id
|
checkout_id | integer |
Id. de desprotección. |
|
source_name
|
source_name | string |
Donde se originó el pedido. |
|
fulfillment_status
|
fulfillment_status | string |
Estado del pedido en términos de elementos de línea cumplidos. |
|
tax_lines
|
tax_lines | tax_lines |
Una lista de objetos de línea de impuestos, cada uno de los cuales detalla un impuesto aplicado al elemento. |
|
tags
|
tags | string |
Etiquetas adjuntas al orden, con formato como una cadena de valores separados por comas. Las etiquetas son descriptores cortos adicionales, que se suelen usar para filtrar y buscar. |
|
contact_email
|
contact_email | string |
Correo electrónico de contacto. |
|
order_status_url
|
order_status_url | string |
Dirección URL que apunta a la página web de estado del pedido, si procede. |
|
presentment_currency
|
presentment_currency | string |
Moneda actual que se usó para mostrar los precios al cliente. |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
|
shipping_lines
|
shipping_lines | shipping_lines |
Detalles del método de envío utilizado. |
|
billing_address
|
billing_address | billing_address |
Dirección de correo asociada al método de pago. Esta dirección es un campo opcional que no estará disponible en pedidos que no requieran un método de pago. |
|
shipping_address
|
shipping_address | shipping_address |
Dirección postal a la que se enviará el pedido. Esta dirección es opcional y no estará disponible en pedidos que no requieran envío. |
|
client_details
|
client_details | client_detail |
Información sobre el explorador que usó el cliente cuando realizó su pedido. |
|
payment_details
|
payment_details | payment_detail |
Objeto que contiene información sobre el pago. |
|
cliente
|
customer | customer |
Información sobre el cliente |
|
line_items
|
line_items | line_items | |
|
Cumplimientos
|
fulfillments | fulfillments |
Matriz de cumplimientos asociados al pedido. |
|
Reembolsos
|
refunds | refunds |
Reembolsos |
cliente
Información sobre el cliente
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único para el cliente. |
|
Correo electrónico
|
string |
Dirección de correo electrónico única del cliente. Al intentar asignar la misma dirección de correo electrónico a varios clientes, se devuelve un error. |
|
|
accepts_marketing
|
accepts_marketing | boolean |
Si el cliente ha consentido recibir material de marketing por correo electrónico. |
|
fecha_de_creación
|
created_at | string |
Fecha y hora (formato ISO 8601) cuando se creó el cliente. |
|
updated_at
|
updated_at | string |
Fecha y hora (formato ISO 8601) cuando la información del cliente se actualizó por última vez. |
|
first_name
|
first_name | string |
Nombre del cliente. |
|
last_name
|
last_name | string |
Apellidos del cliente. |
|
orders_count
|
orders_count | integer |
Número de pedidos asociados a este cliente. |
|
estado
|
state | string |
El estado de la cuenta del cliente con una tienda. Valor predeterminado: deshabilitado. |
|
total_spent
|
total_spent | string |
Cantidad total de dinero que el cliente ha invertido en su historial de pedidos. |
|
last_order_id
|
last_order_id | integer |
Identificador del último pedido del cliente. |
|
nota
|
note | string |
Nota sobre el cliente. |
|
verified_email
|
verified_email | boolean |
Si el cliente ha comprobado su dirección de correo electrónico. |
|
multipass_identifier
|
multipass_identifier | string |
Identificador único para el cliente que se usa con el inicio de sesión de Multipass. |
|
tax_exempt
|
tax_exempt | boolean |
Si el cliente está exento de pagar impuestos en su pedido. Si es true, los impuestos no se aplicarán a un pedido en el momento de la compra. Si es false, los impuestos se aplicarán al pago. |
|
phone
|
phone | string |
Número de teléfono único (formato E.164) para este cliente. Si se intenta asignar el mismo número de teléfono a varios clientes, se produce un error. |
|
tags
|
tags | string |
Etiquetas que el propietario de la tienda ha asociado al cliente, con formato como una cadena de valores separados por comas. Un cliente puede tener hasta 250 etiquetas. Cada etiqueta puede tener hasta 255 caracteres. |
|
last_order_name
|
last_order_name | string |
Nombre del último pedido del cliente. Esto está directamente relacionado con el campo de nombre en el recurso Order. |
|
divisa
|
currency | string |
El código de tres letras (formato ISO 4217) para la moneda que usó el cliente cuando pagó por su último pedido. |
|
Direcciones
|
addresses | addresses |
Una lista de las diez direcciones actualizadas más recientemente para el cliente. |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
Fecha y hora (formato ISO 8601) cuando el cliente consiente o se ha objeto de recibir material de marketing por correo electrónico. |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
Nivel de participación de la suscripción de marketing que el cliente dio cuando consiente recibir material de marketing por correo electrónico. |
|
tax_exemptions
|
tax_exemptions | array of |
Si el cliente está exento de pagar impuestos específicos en su pedido. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
|
default_address
|
default_address | default_address |
default_address
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único de la dirección. |
|
customer_id
|
customer_id | integer |
Identificador único para el cliente. |
|
first_name
|
first_name | string |
Nombre del cliente. |
|
last_name
|
last_name | string |
Apellidos del cliente. |
|
empresa
|
company | string |
La empresa del cliente. |
|
Dirección1
|
address1 | string |
Primera línea de la dirección de correo del cliente. |
|
dirección2
|
address2 | string |
Campo adicional para la dirección de correo del cliente. |
|
city
|
city | string |
Ciudad, pueblo o pueblo del cliente. |
|
provincia
|
province | string |
Nombre de la región del cliente. Normalmente una provincia, un estado o una prefectura. |
|
country
|
country | string |
País del cliente. |
|
archivo comprimido
|
zip | string |
El código postal del cliente, también conocido como código postal, código postal, Eircode, etc. |
|
phone
|
phone | string |
Número de teléfono del cliente en esta dirección. |
|
nombre
|
name | string |
Los nombres y apellidos del cliente. |
|
province_code
|
province_code | string |
Código de dos letras para la región del cliente. |
|
country_code
|
country_code | string |
Código de país de dos letras correspondiente al país del cliente. |
|
country_name
|
country_name | string |
Nombre del país normalizado del cliente. |
|
predeterminado
|
default | boolean |
Devuelve true para cada dirección predeterminada. |
shipping_address
Dirección postal a la que se enviará el pedido. Esta dirección es opcional y no estará disponible en pedidos que no requieran envío.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
Nombre de la persona asociada a la dirección de envío. |
|
Dirección1
|
address1 | string |
Dirección postal de la dirección de envío. |
|
phone
|
phone | string |
Número de teléfono en la dirección de envío. |
|
city
|
city | string |
La ciudad, la ciudad o el pueblo de la dirección de envío. |
|
archivo comprimido
|
zip | string |
El código postal (por ejemplo, código postal, código postal o Eircode) de la dirección de envío. |
|
provincia
|
province | string |
Nombre de la región (por ejemplo, provincia, estado o prefectura) de la dirección de envío. |
|
country
|
country | string |
Nombre del país de la dirección de envío. |
|
last_name
|
last_name | string |
Apellido de la persona asociada a la dirección de envío. |
|
dirección2
|
address2 | string |
Campo adicional opcional para la dirección postal de la dirección de envío. |
|
empresa
|
company | string |
La empresa de la persona asociada a la dirección de envío. |
|
latitud
|
latitude | float |
Latitud de la dirección de envío. |
|
longitud
|
longitude | float |
Longitud de la dirección de envío. |
|
nombre
|
name | string |
Nombre completo de la persona asociada al método de pago. |
|
country_code
|
country_code | string |
El código de dos letras (formato ISO 3166-1) para el país de la dirección de envío. |
|
province_code
|
province_code | string |
Abreviatura de dos letras de la región de la dirección de envío. |
billing_address
Dirección de correo asociada al método de pago. Esta dirección es un campo opcional que no estará disponible en pedidos que no requieran un método de pago.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
Nombre de la persona asociada al método de pago. |
|
Dirección1
|
address1 | string |
Dirección postal de la dirección de facturación. |
|
phone
|
phone | string |
Número de teléfono en la dirección de facturación. |
|
city
|
city | string |
La ciudad, la ciudad o el pueblo de la dirección de facturación. |
|
archivo comprimido
|
zip | string |
El código postal (por ejemplo, código postal, código postal o Eircode) de la dirección de facturación. |
|
provincia
|
province | string |
Nombre de la región (por ejemplo, provincia, estado o prefectura) de la dirección de facturación. |
|
country
|
country | string |
Nombre del país de la dirección de facturación. |
|
last_name
|
last_name | string |
Apellido de la persona asociada al método de pago. |
|
dirección2
|
address2 | string |
Campo adicional opcional para la dirección postal de la dirección de facturación. |
|
empresa
|
company | string |
La empresa de la persona asociada a la dirección de facturación. |
|
latitud
|
latitude | float |
Latitud de la dirección de facturación. |
|
longitud
|
longitude | float |
Longitud de la dirección de facturación. |
|
nombre
|
name | string |
Nombre completo de la persona asociada al método de pago. |
|
country_code
|
country_code | string |
El código de dos letras (formato ISO 3166-1) para el país de la dirección de facturación. |
|
province_code
|
province_code | string |
Abreviatura de dos letras de la región de la dirección de facturación. |
Direcciones
Una lista de las diez direcciones actualizadas más recientemente para el cliente.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
default_address |
shipping_line
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único global. |
|
title
|
title | string |
Título del método de envío. |
|
precio
|
price | string |
El precio de este método de envío en la moneda de la tienda. |
|
código
|
code | string |
Referencia al método de envío. |
|
source
|
source | string |
Origen del método de envío. |
|
phone
|
phone | string |
Número de teléfono en la dirección de envío. |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
Referencia al servicio de suministro que se solicita para el método de envío. Presente si el método de envío requiere el procesamiento por parte de un servicio de suministro de terceros; null en caso contrario. |
|
delivery_category
|
delivery_category | string |
Categoría de entrega. |
|
carrier_identifier
|
carrier_identifier | string |
Referencia al servicio de transportista que proporcionó la tarifa. Presente cuando la tarifa fue calculada por un servicio de operador de terceros. |
|
discounted_price
|
discounted_price | string |
El precio del método de envío después de que se hayan aplicado descuentos de nivel de línea. No refleja los descuentos de nivel de carro ni de pedido. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Lista ordenada de importes asignados por las aplicaciones de descuento. |
|
tax_lines
|
tax_lines | tax_lines |
Una lista de objetos de línea de impuestos, cada uno de los cuales detalla un impuesto aplicado al elemento. |
client_detail
Información sobre el explorador que usó el cliente cuando realizó su pedido.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
Dirección IP del explorador. |
|
accept_language
|
accept_language | string |
Los idiomas y configuraciones regionales que entiende el explorador. |
|
user_agent
|
user_agent | string |
Detalles del cliente de exploración, incluidas las versiones de software y operativos. |
|
session_hash
|
session_hash | string |
Hash de la sesión. |
|
browser_width
|
browser_width | integer |
Ancho de pantalla del explorador en píxeles, si está disponible. |
|
browser_height
|
browser_height | integer |
Alto de la pantalla del explorador en píxeles, si está disponible. |
payment_detail
Objeto que contiene información sobre el pago.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
Número de identificación del emisor (IIN), anteriormente conocido como número de identificación bancaria (BIN), de la tarjeta de crédito del cliente. |
|
avs_result_code
|
avs_result_code | string |
Código de respuesta del sistema de verificación de direcciones (AVS). El código es una sola letra. |
|
cvv_result_code
|
cvv_result_code | string |
El código de respuesta de la compañía de tarjetas de crédito que indica si el cliente escribió correctamente el código de seguridad de la tarjeta (valor de verificación de tarjeta). El código es una sola letra o una cadena vacía. |
|
credit_card_number
|
credit_card_number | string |
Número de tarjeta de crédito del cliente, con la mayoría de los dígitos iniciales censurados. |
|
credit_card_company
|
credit_card_company | string |
Nombre de la empresa que emitió la tarjeta de crédito del cliente. |
subtotal_tax_discount_price_set
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
importe
|
shop_money.amount | string |
Cantidad real. |
|
currency_code
|
shop_money.currency_code | string |
En formato ISO 4217. |
|
importe
|
presentment_money.amount | string |
Cantidad real. |
|
currency_code
|
presentment_money.currency_code | string |
En formato ISO 4217. |
line_item_property
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Nombre del producto. |
|
value
|
value | string |
Valor del producto. |
line_item_properties
Propiedades.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
line_item_property |
cumplimiento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador del suministro. |
|
order_id
|
order_id | integer |
Identificador numérico único del pedido. |
|
estado
|
status | string |
Estado del cumplimiento. |
|
fecha_de_creación
|
created_at | string |
Fecha y hora en que se creó el suministro. |
|
servicio
|
service | string |
Tipo de servicio usado. |
|
updated_at
|
updated_at | string |
Fecha y hora (formato ISO 8601) cuando se modificó por última vez el suministro. |
|
tracking_company
|
tracking_company | string |
Nombre de la empresa de seguimiento. |
|
shipment_status
|
shipment_status | string |
Estado actual del envío del suministro. |
|
location_id
|
location_id | integer |
Identificador único de la ubicación para la que se debe procesar el suministro. |
|
tracking_number
|
tracking_number | string |
Un número de seguimiento, proporcionado por la compañía de envíos. |
|
tracking_numbers
|
tracking_numbers | array of string |
Una lista de números de seguimiento, proporcionados por la compañía de envíos. |
|
tracking_url
|
tracking_url | string |
Dirección URL de la página de seguimiento del suministro. |
|
tracking_urls
|
tracking_urls | array of string |
Las direcciones URL de las páginas de seguimiento para el suministro. |
|
recibo
|
receipt | receipt |
Campo de texto que proporciona información sobre el recibo. |
|
nombre
|
name | string |
El nombre de cumplimiento que identifica de forma única. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
|
line_items
|
line_items | line_items |
Cumplimientos
Matriz de cumplimientos asociados al pedido.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
fulfillment |
transaction
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador de la transacción. |
|
order_id
|
order_id | integer |
Identificador del orden al que está asociada la transacción. |
|
amable
|
kind | string |
Tipo de transacción. |
|
puerta de enlace
|
gateway | string |
Nombre de la puerta de enlace a la que se emitió la transacción. |
|
estado
|
status | string |
El estado de la transacción. |
|
Mensaje
|
message | string |
Cadena generada por el proveedor de pagos con información adicional sobre por qué la transacción se realizó correctamente o produjo un error. |
|
fecha_de_creación
|
created_at | string |
Fecha y hora (formato ISO 8601) cuando se creó la transacción. |
|
test
|
test | boolean |
Si la transacción es una transacción de prueba. |
|
autorización
|
authorization | string |
Código de autorización asociado a la transacción. |
|
location_id
|
location_id | string |
Identificador de la ubicación física donde se procesó la transacción. |
|
user_id
|
user_id | string |
Identificador del usuario que inició sesión en el dispositivo Shopify POS cuando se procesó el pedido, si procede. |
|
parent_id
|
parent_id | integer |
Identificador de una transacción asociada. |
|
processed_at
|
processed_at | string |
Fecha y hora (formato ISO 8601) cuando se procesó una transacción. |
|
device_id
|
device_id | string |
Identificador del dispositivo. |
|
error_code
|
error_code | string |
Un código de error estandarizado, independientemente del proveedor de pagos. |
|
source_name
|
source_name | string |
Origen de la transacción. Esto lo establece Shopify y no se puede invalidar. |
|
importe
|
amount | string |
Cantidad de dinero incluido en la transacción. |
|
divisa
|
currency | string |
El código de tres letras (formato ISO 4217) para la moneda utilizada para el pago. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
transacciones
Lista de transacciones implicadas en el reembolso.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
transaction |
tax_line
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
precio
|
price | string |
Importe del impuesto que se va a cobrar en la moneda de la tienda. |
|
tasa
|
rate | float |
Tasa de impuestos que se va a aplicar. |
|
title
|
title | string |
Nombre del impuesto. |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
Una lista de objetos de línea de impuestos, cada uno de los cuales detalla un impuesto aplicado al elemento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
tax_line |
Reembolsos
Reembolsos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
refund |
reembolso
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único del reembolso. |
|
order_id
|
order_id | integer |
El identificador del pedido, que se usa con fines de API. |
|
fecha_de_creación
|
created_at | string |
Fecha y hora (formato ISO 8601) cuando se creó el reembolso. |
|
nota
|
note | string |
Una nota opcional adjunta a un reembolso. |
|
user_id
|
user_id | integer |
Identificador único del usuario que realizó el reembolso. |
|
processed_at
|
processed_at | string |
Fecha y hora (formato ISO 8601) cuando se importó el reembolso. |
|
reabastecer
|
restock | boolean |
Si desea volver a agregar los elementos de línea al inventario de la tienda. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
|
transacciones
|
transactions | transactions |
Lista de transacciones implicadas en el reembolso. |
|
order_adjustments
|
order_adjustments | array of |
Lista de ajustes de pedido adjuntos al reembolso. |
line_item
Lista de objetos de elemento de línea, cada uno que contiene información sobre un elemento en el orden.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador del elemento de línea. |
|
variant_id
|
variant_id | integer |
Identificador de la variante del producto. |
|
title
|
title | string |
Título del producto. |
|
quantity
|
quantity | integer |
Número de artículos que se compraron. |
|
sku
|
sku | string |
SKU del artículo (unidad de almacenamiento de existencias). |
|
variant_title
|
variant_title | string |
Título de la variante del producto. |
|
vendedor
|
vendor | string |
Nombre del proveedor del elemento. |
|
fulfillment_service
|
fulfillment_service | string |
Proveedor de servicios que cumple el elemento. |
|
product_id
|
product_id | integer |
Identificador del producto al que pertenece el elemento de línea. |
|
requires_shipping
|
requires_shipping | boolean |
Si el artículo requiere envío. |
|
imponible
|
taxable | boolean |
Si el artículo está sujeto a impuestos. |
|
gift_card
|
gift_card | boolean |
Si el artículo de línea es una tarjeta de regalo. |
|
nombre
|
name | string |
Nombre de la variante del producto. |
|
variant_inventory_management
|
variant_inventory_management | string |
Nombre del servicio de administración de inventario. |
|
Propiedades
|
properties | line_item_properties |
Propiedades. |
|
product_exists
|
product_exists | boolean |
Si el producto existe. |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
Cantidad disponible para cumplir. |
|
Gramos
|
grams | integer |
Peso del artículo en gramos. |
|
precio
|
price | string |
El precio del artículo antes de que se hayan aplicado descuentos en la moneda de la tienda. |
|
total_discount
|
total_discount | string |
Importe total del descuento asignado al artículo de línea en la moneda de la tienda. |
|
fulfillment_status
|
fulfillment_status | string |
Estado de un pedido en términos de los elementos de línea que se cumplen. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Lista ordenada de importes asignados por las aplicaciones de descuento. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id. de API de Graphql de administración. |
|
tax_lines
|
tax_lines | tax_lines |
Una lista de objetos de línea de impuestos, cada uno de los cuales detalla un impuesto aplicado al elemento. |
line_items
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
line_item |
Lista de objetos de elemento de línea, cada uno que contiene información sobre un elemento en el orden. |
shipping_lines
Detalles del método de envío utilizado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
shipping_line |
payment_gateway_names
Lista de puertas de enlace de pago usadas para el pedido.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
string |
note_attribute
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Anote el nombre del atributo. |
|
value
|
value | string |
Anote el valor del atributo. |
note_attributes
Información adicional que se agrega al pedido.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
note_attribute |
discount_code
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
Cuando la aplicación de descuento asociada es de tipo código, esta propiedad devuelve el código de descuento que se especificó en la desprotección. |
|
importe
|
amount | string |
Importe que se deduce del total del pedido. Al crear un pedido, este valor es el porcentaje o la cantidad monetaria que se va a deducir. |
|
type
|
type | string |
Tipo de descuento. |
discount_codes
Lista de descuentos aplicados al pedido.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
discount_code |
discount_application
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string |
Tipo de aplicación de descuento. |
|
value
|
value | string |
Valor de la aplicación de descuento como decimal. Esto representa la intención de la aplicación de descuento. |
|
value_type
|
value_type | string |
Tipo del valor. |
|
allocation_method
|
allocation_method | string |
Método por el que se ha asignado el valor de la aplicación de descuento a las líneas autorizadas. |
|
target_selection
|
target_selection | string |
Las líneas del orden, del tipo definido por target_type, que se asigna el descuento. |
|
target_type
|
target_type | string |
Tipo de línea en el pedido en el que se aplica el descuento. |
|
código
|
code | string |
Código de descuento que se usó para aplicar el descuento. Disponible solo para aplicaciones de código de descuento. |
discount_applications
Descripción de la aplicación de descuento, tal como se define por el comerciante o el Script shopify.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
discount_application |
recibo
Campo de texto que proporciona información sobre el recibo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
testcase
|
testcase | boolean |
Si el cumplimiento era un caso de prueba. |
|
autorización
|
authorization | string |
El código de autorización. |