Guias de uso
Documentação GlobalDeveloper HubSuporteStatus da API

Caso de Uso de la Guía de Orders API v0

Mejorar la sincronización de inventario, flujos de trabajo y herramientas de generación de informes para los pedidos.

Suggest Edits

La API de la Versión: v0

¿Cuál es la Órdenes de la API?

La Selling partners puede recuperar y enviar los pedidos de datos de uso de las APIs de las Órdenes de la API. Nuestra Api de ayudar a la Selling Partners de ampliar sus servicios y hacer crecer el seller negocios en Amazon a gran escala.

La Selling Partner de la API para los Pedidos que le ayuda a recuperar mediante programación la información de la Order. Estas Api permiten desarrollar rápida, flexible y personalizado de aplicaciones en áreas como el fin de la sincronización, el fin de la investigación, basada en la demanda y herramientas de apoyo de decisiones.

Para obtener información acerca de la autenticación y autorización, se refieren a la Guía para desarrolladores de la Selling Partner API.

Características clave

  • Recuperar información de pedidos con criterios de filtrado: El getOrders funcionamiento de las Órdenes de la API devuelve los pedidos creados o actualizados durante el marco de tiempo o de otros criterios de filtrado indicado por los parámetros especificados. Si NextToken está presente,se utiliza para recuperar las órdenes en lugar de otros criterios.
  • Recuperar el Order especificado información: La operación getOrder de las Órdenes de la API devuelve la información de la Order que usted especifique.
  • Order de recuperación de la información del artículo para el Order especificado: La operación getOrderItems de las Órdenes de la API devuelve detallada de la posición de pedido de información para el pedido que usted especifique. Si NextToken se proporciona, se utiliza para recuperar la siguiente página de artículos de la Order.
  • Confirmar el envío de la Order especificado: La operación confirmShipment de las Órdenes de la API confirma el estado de envío de un Order especificado. También se puede utilizar para editar los detalles del envío de los pedidos que han sido enviados.

Tutorial 1: Recuperar información de pedidos con criterios de filtrado

La operación getOrders de las Órdenes de la API devuelve los pedidos creados o actualizados durante el marco de tiempo o de otros criterios de filtrado indicado por los parámetros especificados. Si NextToken está presente, que se utiliza para recuperar las órdenes en lugar de otros criterios.

🚧

La Recuperación De Datos De Retraso

La operación getOrders tiene un sistemático retraso en la recuperación de datos. Más actualizado de los datos de pedidos estarán disponibles 2 minutos después de que una Order se creó o actualizó por última vez. Para asegurarse de que usted va a recuperar el más reciente de datos de pedidos, llame a la operación de 2 minutos después de la Order es creado o actualizado.

Requisitos previos

Para completar con éxito este tutorial, usted debe:

Para acceder a comprador y/o información de dirección de envío, usted debe tener la aprobación de los siguientes roles:

getOrders solicitud

Llame a la operación getOrders.

Los parámetros de la consulta

NombreDescripciónSe requiere
CreatedAfterUna fecha utilizada para la selección de los pedidos creados después de (o en) un período de tiempo especificado. Sólo los pedidos realizados después de la hora especificada se volvió. Usted debe proporcionar el parámetro CreatedAfter o los parámetros LastUpdatedAfter. Si ambos están vacíos la llamada no es válido.No
CreatedBefore*Una fecha utilizada para la selección de los pedidos creados antes de (o en) un período de tiempo especificado. Sólo los pedidos realizados antes de la hora especificada se volvió. La fecha debe estar en formato ISO 8601.No
LastUpdatedAfterUna fecha utilizada para la selección de los pedidos que fueron actualizados por última vez después de (o en) un período de tiempo especificado. Una actualización se define como cualquier cambio en el estado del pedido, incluyendo la creación de un nuevo Order. Incluye las actualizaciones realizadas por Amazon y el seller. La fecha debe estar en formato ISO 8601.Usted debe proporcionar el parámetro CreatedAfter o los parámetros LastUpdatedAfter. Si ambos están vacíos la llamada no es válido.No
LastUpdatedBeforeUna fecha utilizada para la selección de los pedidos que fueron actualizados por última vez antes de (o en) un período de tiempo especificado. Una actualización se define como cualquier cambio en el estado del pedido, incluyendo la creación de un nuevo Order. Incluye las actualizaciones realizadas por Amazon y el seller. La fecha debe estar en formato ISO 8601.No
OrderStatusesUna lista de OrderStatus valores que se usan para filtrar los resultados.

Valores posibles:
- PendingAvailability (Esta situación está disponible para pre-pedidos. El pedido ha sido realizado, el pago no ha sido autorizado, y la fecha de lanzamiento de la partida es en el futuro).
- Pending (El pedido ha sido realizado, pero el pago no ha sido autorizado).
- Unshipped (De pago ha sido autorizada y, el pedido está listo para el envío, pero no hay elementos en el Order en que han sido enviados).
- PartiallyShipped (Uno o más, pero no todos, los elementos en el Order en que han sido enviados).
- Shipped (Todos los elementos en el Order en que han sido enviados).
- InvoiceUnconfirmed (Todos los elementos en el Order en que han sido enviados. El seller no ha dado todavía la confirmación de Amazon para que la factura ha sido enviado al comprador.)
- Canceled (El pedido ha sido cancelado.)
- Unfulfillable (El Order no puede ser cumplido. Este estado sólo se aplica a la Multi-Canal de Cumplimiento de los pedidos.)		No
MarketplaceIdsUna lista de MarketplaceId valores. Se utiliza para seleccionar los pedidos que se colocan en la especificados marketplaces.

Se refieren a la Guía para desarrolladores de la Selling Partner API para obtener una lista completa de marketplaceId valores.
Recuento máximo : 50		Sí
FulfillmentChannelsUna lista que indica cómo una Order se cumplió. Filtra los resultados por el cumplimiento de canal. Valores posibles: AFN (el Cumplimiento por parte de Amazon); NMF (Cumplido por el seller).No
PaymentMethodsUna lista de método de pago de los valores. Se utiliza para seleccionar los pedidos pagados mediante el especificado los métodos de pago. Valores posibles: COD (Cash on delivery); CVS (tienda de Conveniencia de pago), Otros (Cualquier método de pago distinto de BACALAO o CVS).No
BuyerEmailLa dirección de correo electrónico de un comprador. Se utiliza para seleccionar los pedidos que contienen la dirección de correo electrónico especificada.No
SellerOrderIdUn identificador especificado por el seller. Se utiliza para seleccionar sólo las órdenes que coincida con el identificador. Si SellerOrderId se especifica, a continuación, FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, y BuyerEmail no se puede especificar.No
MaxResultsPerPageUn número que indica el número máximo de órdenes que pueden ser devueltos por página. El valor debe ser 1 - 100. Por defecto 100.No
EasyShipShipmentStatusesUna lista de EasyShipShipmentStatus valores. Se utiliza para seleccionar Fácil enviar los pedidos con los estados que coinciden con los valores especificados. Si EasyShipShipmentStatus se especifica, sólo Amazon Fácil enviar los pedidos devueltos.

Valores posibles:
- PendingSchedule (El paquete está a la espera de la programación de la pick-up.)
- PendingPickUp (Amazon aún no ha recogido el paquete del seller.)
- PendingDropOff (El seller entregará el paquete a la compañía.)
- LabelCanceled (El seller cancela la camioneta.)
- PickedUp (Amazon ha recogido el paquete del seller.)
- DroppedOff (El paquete es entregado a la compañía por el seller.)
- AtOriginFC (El paquete está en el origen centro de cumplimiento.)
- AtDestinationFC (El paquete al destino en el centro de cumplimiento.)
- Delivered (El paquete ha sido entregado.)
- RejectedByBuyer (El paquete ha sido rechazada por el comprador.)
- Undeliverable (El paquete no puede ser entregado.)
- ReturningToSeller (El paquete no se ha entregado y se devuelve al seller.)
- ReturnedToSeller (El paquete no se entregó y fue devuelto al seller.)
- Lost (El paquete se pierde.)
- OutForDelivery (El paquete se fuera para la entrega.)
- Damaged (El paquete fue dañado por el transportista.)		No
ElectronicInvoiceStatusesUna lista de ElectronicInvoiceStatus valores. Se utiliza para seleccionar los pedidos con la factura electrónica en los estados que coinciden con los valores especificados.

Valores posibles:
- NotRequired (El envío de factura electrónica no es necesario para este fin.)
- NotFound (La factura electrónica no se había presentado para este fin.)
- Processing (La factura electrónica es procesado por este Order.)
- Errored (La última presentada la factura electrónica fue rechazada por este Order.)
- Accepted (La última presentada la factura electrónica fue presentado y aceptado.)		No
NextTokenUna string de token devuelto en la respuesta de su solicitud anterior.No
AmazonOrderIdsUna lista de AmazonOrderId valores. Una AmazonOrderId es de Amazon definido por el identificador, en 3-7-7 formato.
Recuento máximo : 50		No
ActualFulfillmentSupplySourceIdIndica la recomendada sourceId donde el Order debe ser cumplida de.No
IsISPUCuando es true, este Order está marcado para ser recogidos en una tienda en lugar de entrega.No
StoreChainStoreIdLa tienda de la string de identificador de tienda. Vinculado a una tienda específica en una tienda de la string.No

Ejemplo de solicitud

GET https://sellingpartnerapi-eu.amazon.com/orders/v0/orders?
    MarketplaceIds=ATVPDKIKX0DER
    &CreatedAfter=2020-10-10
    &MaxResultPerPage=2

Respuesta

Una respuesta correcta incluye lo siguiente:

NombreDescripciónSe requiere
OrdersUna lista de pedidos.
Tipo de Order de la matriz		Sí
NextTokenCuando está presente y no está vacío, pasa esta string de token en la siguiente solicitud de devolución de la siguiente página de respuesta.No
LastUpdatedBeforeUna fecha utilizada para la selección de los pedidos que fueron actualizados por última vez antes de (o en) un período de tiempo especificado. Una actualización se define como cualquier cambio en el estado del pedido, incluyendo la creación de un nuevo Order. Incluye las actualizaciones realizadas por Amazon y el seller. Todas las fechas deben estar en formato ISO 8601.No
CreatedBeforeUna fecha utilizada para la selección de los pedidos creados antes de (o en) un período de tiempo especificado. Sólo los pedidos realizados antes de la hora especificada se volvió. La fecha debe estar en formato ISO 8601.No

Ejemplo de respuesta

{
"NextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4",
"Orders": [
  {
    "AmazonOrderId": "902-3159896-1390916",
    "PurchaseDate": "2017-01-20T19:49:35Z",
    "LastUpdateDate": "2017-01-20T19:49:35Z",
    "OrderStatus": "Pending",
    "FulfillmentChannel": "SellerFulfilled",
    "NumberOfItemsShipped": 0,
    "NumberOfItemsUnshipped": 0,
    "PaymentMethod": "Other",
    "PaymentMethodDetails": [
      "CreditCard",
      "GiftCerificate"
    ],
    "MarketplaceId": "ATVPDKIKX0DER",
    "ShipmentServiceLevelCategory": "Standard",
    "OrderType": "StandardOrder",
    "EarliestShipDate": "2017-01-20T19:51:16Z",
    "LatestShipDate": "2017-01-25T19:49:35Z",
    "IsBusinessOrder": false,
    "IsPrime": false,
    "IsAccessPointOrder": false,
    "IsGlobalExpressEnabled": false,
    "IsPremiumOrder": false,
    "IsSoldByAB": false,
    "IsIBA": false,
    "ShippingAddress": {
      "Name": "Michigan address",
      "AddressLine1": "1 Cross St.",
      "City": "Canton",
      "StateOrRegion": "MI",
      "PostalCode": "48817",
      "CountryCode": "US"
    },
    "BuyerInfo": {
      "BuyerEmail": "[email protected]",
      "BuyerName": "John Doe",
      "BuyerTaxInfo": {
        "CompanyLegalName": "A Company Name"
      },
      "PurchaseOrderNumber": "1234567890123"
    }
  }
]
}

Tutorial 2: Recuperar la información de la Order

El tutorial se muestra cómo utilizar la operación getOrder de las Órdenes de la API para recuperar la información de la Order que usted especifique.

Requisitos previos

Para completar con éxito este tutorial, usted debe:

Para acceder a comprador y/o información de dirección de envío, usted debe tener la aprobación de los siguientes roles:

solicitud

ParámetroDescripciónSe requiere
orderIdAmazon definido por el identificador, en 3-7-7 formato.

Tipo: string de		Sí

Ejemplo de solicitud

GET https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/

Respuesta

Una respuesta correcta incluye lo siguiente:

NombreDescripciónSe requiere
OrderLa información de la Order.
Tipo: Order		Sí

Refiérase a la Order en la referencia de la API para obtener más detalles acerca de los posibles objetos y propiedades en una Order.

Ejemplo de respuesta

{
"payload": {
  "BuyerInfo": {},
  "AmazonOrderId": "026-1520163-6049104",
  "EarliestShipDate": "2022-03-10T00:00:00Z",
  "SalesChannel": "Amazon.co.uk",
  "AutomatedShippingSettings": {
    "HasAutomatedShippingSettings": false
  },
  "OrderStatus": "Canceled",
  "NumberOfItemsShipped": 0,
  "OrderType": "StandardOrder",
  "IsPremiumOrder": false,
  "IsPrime": false,
  "FulfillmentChannel": "MFN",
  "NumberOfItemsUnshipped": 0,
  "HasRegulatedItems": true,
  "IsReplacementOrder": false,
  "IsSoldByAB": false,
  "LatestShipDate": "2022-03-10T23:59:59Z",
  "ShipServiceLevel": "Std UK Dom_1",
  "IsISPU": false,
  "MarketplaceId": "A1F83G8C2ARO7P",
  "PurchaseDate": "2022-03-09T22:03:02Z",
  "IsAccessPointOrder": false,
  "IsBusinessOrder": false,
  "OrderTotal": {
    "CurrencyCode": "GBP",
    "Amount": "20.00"
  },
  "PaymentMethodDetails": [
    "Standard"
  ],
  "IsGlobalExpressEnabled": false,
  "LastUpdateDate": "2022-03-14T22:05:14Z",
  "ShipmentServiceLevelCategory": "Standard"
}
}

Tutorial 3: Recuperar detallada de la posición de pedido de información

El tutorial se muestra cómo utilizar la operación getOrderItems de las Órdenes de la API para recuperar la información de la Order que usted especifique.

Requisitos previos

Para completar con éxito este tutorial, usted debe:

Para acceder a comprador y/o información de dirección de envío, usted debe tener la aprobación de los siguientes roles:

solicitud

Tipo deParámetroDescripciónSe requiere
CaminoorderIdAmazon definido por el identificador, en 3-7-7 formato.

Tipo: string de		Sí
ConsultaNextTokenUna string de token devuelto en la respuesta de su solicitud anterior.

Tipo: string de		No

Ejemplo de solicitud

GET https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/902-0300094-5705429/orderItems

Respuesta

Una respuesta correcta incluye lo siguiente:

NombreDescripciónSe requiere
OrderItemsUna lista de artículos de la Order.
Tipo de OrderItem matriz		Sí
NextTokenCuando está presente y no está vacío, pasa esta string de token en la siguiente solicitud de devolución de la siguiente página de respuesta.No
AmazonOrderIdAmazon definido por el identificador, en 3-7-7 formato.Sí

Ejemplo de respuesta

{
"payload": {
    "OrderItems": [
        {
            "TaxCollection": {
                "Model": "MarketplaceFacilitator",
                "ResponsibleParty": "Amazon Services, Inc."
            },
            "ProductInfo": {
                "NumberOfItems": "1"
            },
            "BuyerInfo": {},
            "ItemTax": {
                "CurrencyCode": "USD",
                "Amount": "1.13"
            },
            "QuantityShipped": 1,
            "BuyerRequestedCancel": {
                "IsBuyerRequestedCancel": "false",
                "BuyerCancelReason": ""
            },
            "ItemPrice": {
                "CurrencyCode": "USD",
                "Amount": "11.00"
            },
            "ASIN": "B004RKQM8I",
            "SellerSKU": "AN-M9GI-4QE5",
            "Title": "Sony MDR-ZX100 ZX Series Headphones (White)",
            "IsGift": "false",
            "ConditionSubtypeId": "Acceptable",
            "IsTransparency": false,
            "QuantityOrdered": 1,
            "PromotionDiscountTax": {
                "CurrencyCode": "USD",
                "Amount": "0.00"
            },
            "ConditionId": "Used",
            "PromotionDiscount": {
                "CurrencyCode": "USD",
                "Amount": "0.00"
            },
            "OrderItemId": "43345934312798"
        }
    ],
    "AmazonOrderId": "902-0300094-5705429"
}
}

Tutorial 4: Confirmar el envío

Este tutorial muestra cómo confirmar un envío con la operación confirmShipment después de recibir una notificación de que su pedido está listo para ser cumplido. Usted no tendrá que confirmar el envío, si usted compra una etiqueta de envío a través de la API de Envío o comprar el envío de interfaz de usuario. La operación confirmShipment soporta todos los casos de uso que fueron apoyados en el Cumplimiento de la Order, alimentos, incluyendo el apoyo a varios de seguimiento de los Identificadores de cada pedido. Para enviar múltiples de seguimiento del paquete Id, usted tendrá que enviar varias solicitudes con el mismo ID de pedido pero de diferentes paquetes de IDs de referencia.

Ejemplo:

CallOrderIDPackageReferenceId
1ra Convocatoria902-0300094-570542101
2º Llamar902-0300094-570542102

El paquete de ID de referencia es compatible con cualquier positivo valor numérico y está destinado a propósito de la edición de un envío después de haber confirmado un envío. Usted puede presentar cualquier valor numérico packageReferenceID y vamos a almacenar los datos. Si usted necesita hacer una edición para el envío, enviar otra operación confirmShipment con el mismo packageReferenceID. Los otros detalles del envío será editado en el éxito de la presentación. Si usted no pone ningún tipo de IDENTIFICACIÓN cuando usted envíe, Amazon asignará automáticamente un packageReferenceID.

Requisitos previos

Para completar con éxito este tutorial, usted debe:

Si usted ha sido aprobado para el Directo-a-Consumidor de Entrega (Restringido) papel, usted tendrá acceso a la operación confirmShipment.

Paso 1. Confirmar el envío de una Order de

Llame a la operación confirmShipment, pasando los siguientes parámetros:

Ruta de los parámetros de

ParámetroDescripciónSe requiere
orderIdAmazon definido por el identificador, en 3-7-7 formato.

Tipo: string de		Sí

Parámetros del cuerpo

NombreDescripciónSe requiere
packageDetailPropiedades de los paquetes de
Tipo PackageDetail		Sí
codCollectionMethodEl bacalao método de recolección, apoyo en JP sólo.
Tipo De CodCollectionMethod		No
marketplaceIdEl unobfuscated marketplace identificador.
Tipo De MarketplaceId		Sí

Ejemplo de solicitud

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation
{
  "marketplaceId": "ATVPDKIKX0DER",
  "codCollectionMethod": "",
  "packageDetail": {
      "packageReferenceId": "123",
      "carrierCode": "UPS",
      "carrierName": "UPS",
      "shippingMethod": "SHIPPING",
      "trackingNumber": "1Z86V8030385598957",
      "shipDate": "2022-11-30T16:15:30Z",
      "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
      "orderItems":[{
          "orderItemId": "60696125413094",
          "quantity": 1
      }]
  }
}

Respuesta

Propiedades de respuesta:

Código HTTPDescripciónEsquema
204Éxito.
Encabezados :
x-amzn-RateLimit-Limit (string) : El límite de velocidad (requestes por segundo) para esta operación.
x-amzn-RequestId (string) : Única solicitud identificador de referencia.		Ningún Contenido

Para los códigos de estado de error, descripciones y esquemas, consulte para Confirmar el Envío de Respuesta de Error.

Paso 2. Editar la información de envío para un pedido

Después del paso 1, se crea un paquete para la Order. Usted todavía puede editar la información de envío le gusta de la fecha de envío, la compañía aérea, servicio de Envío (o método de la Nave), ID de Seguimiento (proporcionado por el transportista) llamando a la operación confirmShipment de nuevo.

Los parámetros que deben ser coherentes

Para asegurarse de que usted está editando el mismo envío, por favor siga los siguientes parámetros sin cambios.

ParámetroDescripciónEn
orderIdAmazon definido por el identificador, en 3-7-7 formato.

Tipo: string de		Camino
packageReferenceIdUn seller suministrado por el identificador que identifica de forma única un paquete dentro del ámbito de una Order. Tenga en cuenta que sólo un valor numérico positivo es compatible".

Tipo: string de		PackageDetail
orderItemIdEl identificador único de la Order de pedido.

Tipo: string de		ConfirmShipmentOrderItem
quantityLa cantidad del artículo.

Tipo: entero		ConfirmShipmentOrderItem

Ejemplo de solicitud

POST https://sellingpartnerapi-eu.amazon.com/orders/v0/orders/205-1725759-9209952/shipmentConfirmation
{
  "marketplaceId": "ATVPDKIKX0DER",
  "codCollectionMethod": "",
  "packageDetail": {
      "packageReferenceId": "123",
      "carrierCode": "USPS",
      "carrierName": "USPS",
      "shippingMethod": "SHIPPING",
      "trackingNumber": "1Z86V8030385598957",
      "shipDate": "2022-11-30T20:15:30Z",
      "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
      "orderItems":[{
          "orderItemId": "60696125413094",
          "quantity": 1
      }]
  }
}

Respuesta

Propiedades de respuesta:

Código HTTPDescripciónEsquema
204Éxito.
Encabezados :
x-amzn-RateLimit-Limit (string) : El límite de velocidad (requestes por segundo) para esta operación.
x-amzn-RequestId (string) : Única solicitud identificador de referencia.		Ningún Contenido

Para los códigos de estado de error, descripciones y esquemas, se refieren a las respuestas de Error y esquemas.

Updated over 1 year ago