Abrir la plataforma de cadena de suministro (versión preliminar)
Open Supply Chain Platform (OSCP) Service proporciona una API REST eficaz y extensa. Con estas API, el cliente puede crear y administrar OrderFulfillment, almacenamiento en OSCP. OSCP se integrará con varios asociados, incluidos minoristas, proveedores logísticos y empresas de almacenamiento entre otros, e impulsará la eficiencia integral en toda la cadena de suministro mediante la integración de datos, operaciones y análisis entre los asociados.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| 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) |
| Contacto | |
|---|---|
| Nombre | Microsoft |
| URL | https://azure.microsoft.com/support/ |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft Corporation |
| Sitio web | https://azure.microsoft.com/ |
| Directiva de privacidad | https://www.microsoft.com/en-in/trust-center/privacy |
| Categorías | Colaboración; Datos |
Open Supply Chain Platform (OSCP) es un servicio de Azure que proporciona una plataforma extensible para detectar, consumir y ampliar aplicaciones de cadena de suministro integradas creadas por Microsoft y asociados. Estas aplicaciones ayudan a las organizaciones a desbloquear valiosas conclusiones empresariales y eficiencias de los datos dentro de su organización y más allá.
Prerrequisitos
Debe ser un usuario de una aplicación de OSCP para usar este conector. Debe tener un área de trabajo creada en OSCP. Debe usar un identificador de Entra de Microsoft.
Obtención de credenciales
Para agregar este conector al flujo de trabajo, primero debe iniciar sesión en la cuenta de Identificador de Entra de Microsoft con rol de OSCP (Contibutor/Reader) en la aplicación de OSCP a la que desea conectarse.
Errores y soluciones comunes
Si el usuario no tiene acceso al contibutor de OSCP en el área de trabajo, el usuario recibirá el error (404) del área de trabajo. Para corregir esta necesidad de que el usuario tenga acceso al contibutor de OSCP para el área de trabajo.
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 | Descripción | Obligatorio |
|---|---|---|---|
| Id. del área de trabajo | cuerda / cadena | Especificar solo el identificador del área de trabajo | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualiza un envío |
Actualiza un envío. |
| Actualiza un pedido de envío |
Actualiza un pedido de envío. |
| Actualiza un plan de cumplimiento |
Actualiza un plan de suministro dado el identificador del área de trabajo, el identificador del plan de suministro y la carga del plan de suministro. |
| Actualiza una solicitud de oferta de envío |
Actualiza una solicitud de oferta de envío. |
| Cancela el cumplimiento de pedidos por identificador de cumplimiento de pedidos |
Cancela el cumplimiento de pedidos por identificador de suministro de pedidos. |
| Crea la solicitud de ejecución de flujo de datos. |
Crea la solicitud de ejecución de flujo de datos para un área de trabajo. |
| Crea o actualiza el flujo de datos. |
Crea o actualiza el flujo de datos de un área de trabajo. |
| Crea o actualiza el flujo de salida de datos. |
Crea o actualiza el flujo de salida de datos de un área de trabajo. |
| Crea o actualiza un almacén |
Crea o actualiza un almacén por identificador de almacenamiento. |
| Crea o actualiza un conjunto de datos |
Crea o actualiza un conjunto de datos que tiene el nombre especificado. |
| Crea o actualiza un elemento |
Crea o actualiza el elemento para el identificador y la SKU del área de trabajo especificados. |
| Crea o actualiza un elemento de almacenamiento |
Crea o actualiza un elemento de almacenamiento por identificador de almacenamiento y sku de elementos. |
| Crea o actualiza un nodo de entrega |
Crea o actualiza el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados. |
| Crea o actualiza un operador con el identificador de operador |
Crea o actualiza un operador con el identificador de operador de un área de trabajo. |
| Crea o actualiza una lista de elementos |
Crea o actualiza una lista de elementos para un identificador de área de trabajo y sku especificados. |
| Crea o actualiza una lista de elementos de almacenamiento |
Crea o actualiza una lista de elementos de almacenamiento por identificador de almacenamiento y sku de elementos. |
| Crea o actualiza una lista de nodos de entrega |
Crea o actualiza una lista de nodos de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados. |
| Crea o actualiza una oferta de envío |
Crea o actualiza una cotización de envío. |
| Crea un envío |
Crea un envío. |
| Crea un nuevo suministro de pedidos para el identificador de suministro de pedidos |
Crea un nuevo suministro de pedidos para el identificador de suministro de pedidos. |
| Crea un pedido de envío |
Crea un pedido de envío. |
| Crea una lista de almacenes |
Crea una lista de almacenes para un identificador de área de trabajo determinado y una lista de objetos de almacenamiento. |
| Crea una lista de pedidos de envío |
Crea una lista de pedidos de envío. |
| Crea una solicitud de oferta de envío |
Crea una solicitud de oferta de envío. |
| Desencadena una ejecución para la instancia de flujo de salida de datos |
Desencadena una ejecución para la instancia de flujo de datos para un nombre determinado. |
| Elimina el flujo de datos. |
Elimina el flujo de datos para el nombre y el área de trabajo especificados. |
| Elimina el flujo de salida de datos. |
Elimina el flujo de salida de datos para el nombre y el área de trabajo especificados. |
| Elimina el nodo de entrega. |
Elimina el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados. |
| Elimina un almacén por identificador de almacenamiento |
Elimina un almacén por identificador de almacén. |
| Elimina un conjunto de datos que tiene el nombre especificado. |
Elimina un conjunto de datos que tiene el nombre especificado. |
| Elimina un elemento de almacenamiento por identificador de almacenamiento y sku de elementos. |
Elimina un elemento de almacenamiento por identificador de almacenamiento y sku de elementos. |
| Elimina un elemento para una SKU determinada. |
Elimina un elemento para una SKU determinada. |
| Elimina un operador con el identificador de operador. |
Elimina un operador con el identificador de operador de un área de trabajo. |
| Elimina una lista de almacenes |
Elimina una lista de almacenes para un identificador de área de trabajo determinado y una lista de identificadores de almacenamiento. |
| Elimina una lista de elementos de almacenamiento por identificadores de almacenamiento |
Elimina una lista de elementos de almacenamiento por identificadores de almacenamiento. |
| Elimina una lista de elementos para las sku dadas. |
Elimina una lista de elementos para las sku dadas. |
| Elimina una lista de nodos de entrega. |
Elimina los nodos de entrega de los identificadores de nodo de entrega especificados. |
| Enumeración de todas las ejecuciones para un flujo de datos determinado |
Enumere todas las ejecuciones para el nombre de flujo de datos especificado. |
| Enumeración de todas las ejecuciones para un flujo de salida de datos determinado |
Enumere todas las ejecuciones para el nombre de flujo de salida de datos determinado. |
| Genera opciones de suministro |
Genera opciones de suministro para el identificador de área de trabajo y la solicitud de suministro dadas. |
| Recupera el flujo de datos. |
Recupera el flujo de datos para el nombre y el área de trabajo especificados. |
| Recupera el flujo de salida de datos. |
Recupera el flujo de salida de datos para el nombre y el área de trabajo especificados. |
| Recupera el suministro de pedidos por identificador de suministro de pedidos |
Recupera el suministro de pedidos por identificador de suministro de pedidos. |
| Recupera la ejecución de flujo de datos para el identificador de ejecución. |
Recupera la ejecución de flujo de datos para un identificador de ejecución determinado. |
| Recupera los detalles de ejecución para el flujo de salida de datos y el identificador de ejecución especificados. |
Recupera los detalles de ejecución para el nombre de flujo de salida de datos y el identificador de ejecución especificados. |
| Recupera los nodos de entrega para un área de trabajo determinada. |
Recupera los nodos de entrega para un identificador de área de trabajo determinado. |
| Recupera subdirectorios de un conjunto de datos. |
Recupera subdirectorios de un conjunto de datos que tiene el nombre especificado. |
| Recupera todos los almacenes de un área de trabajo. |
Recupera todos los almacenes de un área de trabajo. |
| Recupera todos los conjuntos de datos de un área de trabajo. |
Recupera todos los conjuntos de datos de un área de trabajo. |
| Recupera todos los flujos de datos. |
Recupera todos los flujos de datos de un área de trabajo determinada. |
| Recupera todos los flujos de salida de datos de un área de trabajo. |
Recupera todos los flujos de salida de datos para un área de trabajo determinada. |
| Recupera un almacén por identificador de almacenamiento |
Recupera un almacén por identificador de almacenamiento. |
| Recupera un conjunto de datos que tiene el nombre especificado. |
Recupera un conjunto de datos que tiene el nombre especificado. |
| Recupera un elemento |
Recupera el elemento para el identificador de área de trabajo y la SKU especificados. |
| Recupera un elemento de almacenamiento por identificador de almacenamiento y sku de elementos. |
Recupera un elemento de almacenamiento por identificador de almacenamiento y sku de elementos. |
| Recupera un envío por identificador de envío |
Recupera un envío por identificador de envío. |
| Recupera un nodo de entrega |
Recupera el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados. |
| Recupera un operador con el identificador de operador. |
Recupera un operador con el identificador de operador de un área de trabajo. |
| Recupera un pedido de envío |
Recupera un pedido de envío. |
| Recupera un plan de cumplimiento |
Recupera el plan de suministro para el identificador de área de trabajo y el identificador del plan de cumplimiento especificados. |
| Recupera una cotización de envío |
Recupera una cotización de envío. |
| Recupera una lista de planes de suministro con un estado de cumplimiento específico. |
Recupera una lista de planes de suministro con un estado de suministro específico para el identificador de área de trabajo y el identificador de almacenamiento especificados. |
| Recupera una solicitud de oferta de envío |
Recupera una solicitud de oferta de envío. |
Actualiza un envío
Actualiza un envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de envío.
|
shipmentId | True | string |
Id. de envío. |
|
id
|
id | True | string |
Identificador único de un envío. |
|
estado
|
status | string |
Estado del envío. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
La lista de identificadores de pedido de envío que atiende el envío. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
trackingNumber
|
trackingNumber | string |
Número de seguimiento |
|
|
trackingUrl
|
trackingUrl | string |
Dirección URL de seguimiento |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Dirección URL de etiqueta de envío |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional de envío capturada como pares clave-valor. |
|
|
carrierName
|
carrierName | string |
Nombre del transportista del envío |
Devoluciones
Una cantidad de artículos, mercancías o carga masiva que se envían juntos.
- Body
- Shipment
Actualiza un pedido de envío
Actualiza un pedido de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del pedido de envío.
|
shipmentOrderId | True | string |
Identificador del pedido de envío. |
|
id
|
id | True | string |
Identificador único de un pedido de envío. |
|
shipmentId
|
shipmentId | string |
Identificador de un envío que envía este pedido de envío. |
|
|
estado
|
status | string |
Estado del pedido de envío. |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del pedido de envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional del pedido de envío capturada como pares clave-valor. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc.
- Body
- ShipmentOrder
Actualiza un plan de cumplimiento
Actualiza un plan de suministro dado el identificador del área de trabajo, el identificador del plan de suministro y la carga del plan de suministro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del plan de cumplimiento.
|
fulfillmentPlanId | True | string |
Identificador del plan de cumplimiento. |
|
id
|
id | string |
Identificador único de un suministro. |
|
|
warehouseId
|
warehouseId | string |
Identificador único de un almacén. |
|
|
scheduledExecutionTime
|
scheduledExecutionTime | string | ||
|
ID de pedido
|
orderId | True | string |
Número único que identifica un pedido. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad de elementos. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
La fecha y hora más tempranas en que se debe entregar el pedido. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Fecha y hora más reciente que se debe entregar el pedido. |
|
id
|
id | True | string |
Identificador único de un envío. |
|
estado
|
status | string |
Estado del envío. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
La lista de identificadores de pedido de envío que atiende el envío. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
trackingNumber
|
trackingNumber | string |
Número de seguimiento |
|
|
trackingUrl
|
trackingUrl | string |
Dirección URL de seguimiento |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Dirección URL de etiqueta de envío |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional de envío capturada como pares clave-valor. |
|
|
carrierName
|
carrierName | string |
Nombre del transportista del envío |
|
|
estado
|
status | string |
Estado del plan de suministro. |
|
|
statusReason
|
statusReason | string | ||
|
Tiempo de creación
|
creationTime | string |
Marca de tiempo que se creó el plan de suministro. |
Devoluciones
Las actividades previstas o reales relacionadas con el cumplimiento de una orden. Estas actividades pueden incluir la creación de listas de selección, la ejecución de la lista de selección, el empaquetado y el envío de los elementos al destino final.
- Body
- FulfillmentPlan
Actualiza una solicitud de oferta de envío
Actualiza una solicitud de oferta de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de oferta de envío.
|
shipmentQuoteRequestId | True | string |
Identificador de solicitud de oferta de envío. |
|
id
|
id | True | string |
Identificador único de una solicitud de oferta de envío. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identificadores de oferta de envío correspondientes a la solicitud de oferta de envío |
|
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del envío. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
Detalles de la solicitud de oferta de envío
- Body
- ShipmentQuoteRequest
Cancela el cumplimiento de pedidos por identificador de cumplimiento de pedidos
Cancela el cumplimiento de pedidos por identificador de suministro de pedidos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cumplimiento del pedido.
|
orderFulfillmentId | True | string |
Identificador de cumplimiento del pedido. |
Devoluciones
- Body
- OrderFulfillment
Crea la solicitud de ejecución de flujo de datos.
Crea la solicitud de ejecución de flujo de datos para un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
|
dataInflowName
|
dataInflowName | string |
Obtiene o establece el nombre de flujo de datos inmutable y único dentro de un área de trabajo. |
|
|
runParams
|
runParams | object |
Obtiene o establece los parámetros necesarios para la ejecución específica de un tipo de conector. |
|
|
dataInflowRunId
|
dataInflowRunId | string |
Obtiene o establece el identificador de ejecución de flujo de datos para la ejecución de flujo de datos. |
|
|
triggeredAt
|
triggeredAt | date-time |
Obtiene o establece el tiempo desencadenado para la ejecución de flujo de datos. |
|
|
completedAt
|
completedAt | date-time |
Obtiene o establece la hora de finalización de la ejecución de flujo de datos. |
|
|
estado
|
status | string |
Obtiene o establece el estado de ejecución de flujo de datos. |
Devoluciones
- Body
- DataInflowRun
Crea o actualiza el flujo de datos.
Crea o actualiza el flujo de datos de un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
|
nombre
|
name | True | string |
Obtiene o establece el nombre de flujo de datos Inmutable y único dentro de un área de trabajo. Este sería el identificador único de un flujo de datos. Proporcionado por el usuario como parámetro de dirección URL obligatorio. |
|
Nombre para mostrar
|
displayName | True | string |
Obtiene o establece el nombre para mostrar de Flujo de datos. |
|
datasetName
|
datasetName | True | string |
Obtiene o establece el nombre del conjunto de datos para el conector. |
|
tipo
|
type | True | string |
Tipo del conector. Ejemplo: CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | True | object |
Propiedades relativas al tipo de conector |
|
output
|
output | object |
Contiene los parámetros de salida que se mostrarían de vuelta al cliente. Por ejemplo, en el caso del conector FilterAndCopy, el identificador de invitación y la ubicación ads se devolverán como parte de la respuesta. |
|
|
tipo
|
type | string |
Tipo de transformador |
|
|
typeProperties
|
typeProperties | object |
Propiedades relativas al tipo de transformador |
|
|
estado
|
state | string |
Obtiene o establece el estado de Flujo de datos. |
Devoluciones
- Body
- DataInflow
Crea o actualiza el flujo de salida de datos.
Crea o actualiza el flujo de salida de datos de un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
|
nombre
|
name | True | string |
Nombre de flujo de salida de datos que es inmutable y único dentro de un área de trabajo. Este sería el identificador único de un flujo de salida de datos. Proporcionado por el usuario como parámetro de dirección URL obligatorio. |
|
Nombre para mostrar
|
displayName | True | string |
Nombre para mostrar del flujo de datos. |
|
descripción
|
description | True | string |
Descripción del flujo de salida de datos. |
|
datasetName
|
datasetName | True | string |
Obtiene o establece el nombre del conjunto de datos para el conector. |
|
nombre
|
name | True | string | |
|
nombre
|
name | True | string | |
|
tipo
|
type | True | string |
Tipo del conector. Ejemplo: CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | True | object |
Propiedades relativas al tipo de conector |
|
output
|
output | object |
Contiene los parámetros de salida que se mostrarían de vuelta al cliente. Por ejemplo, en el caso del conector FilterAndCopy, el identificador de invitación y la ubicación ads se devolverán como parte de la respuesta. |
|
|
tipo
|
type | string |
Tipo de transformador |
|
|
typeProperties
|
typeProperties | object |
Propiedades relativas al tipo de transformador |
|
|
estado
|
state | string |
Estado del flujo de salida de datos. |
Devoluciones
- Body
- DataOutflow
Crea o actualiza un almacén
Crea o actualiza un almacén por identificador de almacenamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
id
|
id | True | string |
Identificador del nodo. |
|
dayOfWeekName
|
dayOfWeekName | string |
El día de la semana. |
|
|
startTime
|
startTime | string |
Hora de inicio. |
|
|
endTime
|
endTime | string |
Hora de finalización. |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
labels
|
labels | array of string |
Etiquetas |
|
|
hora de última modificación
|
lastModifiedTime | date-time | ||
|
pickAndPackLeadTime
|
pickAndPackLeadTime | True | integer |
Obtiene o establece pickAndPackLeadTime, que es el número de horas que requiere Warehouse para seleccionar y empaquetar el elemento. |
|
carrierId
|
carrierId | True | string |
Id. de operador asociado |
|
cutoffTime
|
cutoffTime | True | string |
Tiempo límite del transportista en relación con el almacén. |
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
servingNodeIds
|
servingNodeIds | array of string |
Servir identificadores de nodo, que contiene una lista de identificadores de nodo a los que puede servir el operador actual. Una lista nula o vacía significa que este operador puede servir a cualquier nodo. |
Devoluciones
- Body
- Warehouse
Crea o actualiza un conjunto de datos
Crea o actualiza un conjunto de datos que tiene el nombre especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
nombre
|
name | True | string |
Obtiene o establece el nombre. |
|
nombre
|
name | True | string | |
|
nombre
|
name | True | string | |
|
isDisabled
|
isDisabled | True | boolean |
Obtiene o establece un valor que indica si obtiene o establece el valor isdisabled. |
|
operationalType
|
operationalType | string |
Obtiene o establece el tipo operativo : representa si los datos son transaccionales (Cosmos) o a largo plazo (ADLS) |
|
|
dataModelId
|
dataModelId | True | string |
Obtiene o establece el identificador del modelo de datos. |
|
dataModelVersion
|
dataModelVersion | string |
Obtiene o establece dataModelVersion |
|
|
dataModelType
|
dataModelType | string |
Obtiene o establece el dataModelType. |
|
|
labels
|
labels | array of string |
Etiquetas |
|
|
Nombre del conjunto de datos.
|
name | True | string |
Nombre del conjunto de datos. |
Devoluciones
- Body
- Dataset
Crea o actualiza un elemento
Crea o actualiza el elemento para el identificador y la SKU del área de trabajo especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
SKU de elemento.
|
sku | True | string |
SKU de elemento. |
|
nombre
|
name | string |
Nombre del elemento. |
|
|
descripción
|
description | string |
Descripción del elemento. |
|
|
value
|
value | True | string |
Valor de código de barras. |
|
standardName
|
standardName | True | string |
Nombre estándar del código de barras. |
|
weight
|
weight | True | double |
Peso del elemento estándar. |
|
length
|
length | True | double |
Longitud del elemento estándar. |
|
Ancho
|
width | True | double |
Ancho del elemento estándar. |
|
profundidad
|
depth | True | double |
Profundidad del elemento estándar. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de medida de longitud, ancho y alto. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de peso de medida. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
sku
|
sku | True | string |
Identificador de la unidad de mantenimiento de existencias, que normalmente se usa para las actividades relacionadas con el inventario. |
|
labels
|
labels | array of string |
Etiquetas |
Devoluciones
Algo que está inventariado. Una SKU, unidad de mantenimiento de stock, hace referencia a un elemento específico en una unidad de medida específica.
- Body
- Item
Crea o actualiza un elemento de almacenamiento
Crea o actualiza un elemento de almacenamiento por identificador de almacenamiento y sku de elementos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
SKU de elemento.
|
itemSKU | True | string |
SKU de elemento. |
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Cantidad. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
warehouseId
|
warehouseId | string |
SKU del elemento. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la última vez que se obtuvo este objeto WarehouseItem. |
Devoluciones
- Body
- WarehouseItem
Crea o actualiza un nodo de entrega
Crea o actualiza el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del nodo de entrega.
|
deliveryNodeId | True | string |
Identificador del nodo de entrega. |
|
id
|
id | True | string |
Identificador del nodo. |
|
dayOfWeekName
|
dayOfWeekName | string |
El día de la semana. |
|
|
startTime
|
startTime | string |
Hora de inicio. |
|
|
endTime
|
endTime | string |
Hora de finalización. |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
labels
|
labels | array of string |
Etiquetas |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Devoluciones
Los detalles operativos de la ubicación de entrega, por ejemplo, ubicación, horas de operación, etc.
- Body
- DeliveryNode
Crea o actualiza un operador con el identificador de operador
Crea o actualiza un operador con el identificador de operador de un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del operador.
|
carrierId | True | string |
Identificador del operador. |
|
id
|
id | True | string |
Identificador único de un operador. |
|
tipo
|
type | True | string |
El tipo del operador, solo puede ser lo que admite OSCP. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
Devoluciones
- Body
- Carrier
Crea o actualiza una lista de elementos
Crea o actualiza una lista de elementos para un identificador de área de trabajo y sku especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
nombre
|
name | string |
Nombre del elemento. |
|
|
descripción
|
description | string |
Descripción del elemento. |
|
|
value
|
value | True | string |
Valor de código de barras. |
|
standardName
|
standardName | True | string |
Nombre estándar del código de barras. |
|
weight
|
weight | True | double |
Peso del elemento estándar. |
|
length
|
length | True | double |
Longitud del elemento estándar. |
|
Ancho
|
width | True | double |
Ancho del elemento estándar. |
|
profundidad
|
depth | True | double |
Profundidad del elemento estándar. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de medida de longitud, ancho y alto. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de peso de medida. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
sku
|
sku | True | string |
Identificador de la unidad de mantenimiento de existencias, que normalmente se usa para las actividades relacionadas con el inventario. |
|
labels
|
labels | array of string |
Etiquetas |
Devoluciones
- response
- array of BulkResponseItemOfItem
Crea o actualiza una lista de elementos de almacenamiento
Crea o actualiza una lista de elementos de almacenamiento por identificador de almacenamiento y sku de elementos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Cantidad. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
warehouseId
|
warehouseId | string |
SKU del elemento. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la última vez que se obtuvo este objeto WarehouseItem. |
Devoluciones
Crea o actualiza una lista de nodos de entrega
Crea o actualiza una lista de nodos de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Identificador del nodo. |
|
dayOfWeekName
|
dayOfWeekName | string |
El día de la semana. |
|
|
startTime
|
startTime | string |
Hora de inicio. |
|
|
endTime
|
endTime | string |
Hora de finalización. |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
labels
|
labels | array of string |
Etiquetas |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Devoluciones
Crea o actualiza una oferta de envío
Crea o actualiza una cotización de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de oferta de envío.
|
shipmentQuoteId | True | string |
Id. de oferta de envío. |
|
id
|
id | True | string |
Identificador único de una cotización de envío. |
|
shipmentQuoteRequestId
|
shipmentQuoteRequestId | True | string |
El identificador de la solicitud de oferta de envío a la que está relacionada la cotización de envío. |
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del envío. |
|
|
carrierId
|
carrierId | True | string |
Id. de operador |
|
carrierName
|
carrierName | True | string |
Nombre del operador |
|
customAttributes
|
customAttributes | object |
Información adicional de la oferta de envío capturada como pares clave-valor. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
Detalles de la oferta de envío
- Body
- ShipmentQuote
Crea un envío
Crea un envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de envío.
|
shipmentId | True | string |
Id. de envío. |
|
id
|
id | True | string |
Identificador único de un envío. |
|
estado
|
status | string |
Estado del envío. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
La lista de identificadores de pedido de envío que atiende el envío. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
trackingNumber
|
trackingNumber | string |
Número de seguimiento |
|
|
trackingUrl
|
trackingUrl | string |
Dirección URL de seguimiento |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Dirección URL de etiqueta de envío |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional de envío capturada como pares clave-valor. |
|
|
carrierName
|
carrierName | string |
Nombre del transportista del envío |
Devoluciones
Una cantidad de artículos, mercancías o carga masiva que se envían juntos.
- Body
- Shipment
Crea un nuevo suministro de pedidos para el identificador de suministro de pedidos
Crea un nuevo suministro de pedidos para el identificador de suministro de pedidos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cumplimiento del pedido.
|
orderFulfillmentId | True | string |
Identificador de cumplimiento del pedido. |
|
ID de pedido
|
orderId | True | string |
Número único que identifica un pedido. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad de elementos. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
La fecha y hora más tempranas en que se debe entregar el pedido. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Fecha y hora más reciente que se debe entregar el pedido. |
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
shipmentToName
|
shipmentToName | string | ||
|
shipmentReceiverContact
|
shipmentReceiverContact | string | ||
|
estado
|
status | string | ||
|
id
|
id | string | ||
|
fulfillmentPlanIds
|
fulfillmentPlanIds | array of string | ||
|
Tiempo de creación
|
creationTime | True | date-time | |
|
hora de última modificación
|
lastModifiedTime | True | date-time | |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
Devoluciones
- Body
- OrderFulfillment
Crea un pedido de envío
Crea un pedido de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del pedido de envío.
|
shipmentOrderId | True | string |
Identificador del pedido de envío. |
|
id
|
id | True | string |
Identificador único de un pedido de envío. |
|
shipmentId
|
shipmentId | string |
Identificador de un envío que envía este pedido de envío. |
|
|
estado
|
status | string |
Estado del pedido de envío. |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del pedido de envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional del pedido de envío capturada como pares clave-valor. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc.
- Body
- ShipmentOrder
Crea una lista de almacenes
Crea una lista de almacenes para un identificador de área de trabajo determinado y una lista de objetos de almacenamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Identificador del nodo. |
|
dayOfWeekName
|
dayOfWeekName | string |
El día de la semana. |
|
|
startTime
|
startTime | string |
Hora de inicio. |
|
|
endTime
|
endTime | string |
Hora de finalización. |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
labels
|
labels | array of string |
Etiquetas |
|
|
hora de última modificación
|
lastModifiedTime | date-time | ||
|
pickAndPackLeadTime
|
pickAndPackLeadTime | True | integer |
Obtiene o establece pickAndPackLeadTime, que es el número de horas que requiere Warehouse para seleccionar y empaquetar el elemento. |
|
carrierId
|
carrierId | True | string |
Id. de operador asociado |
|
cutoffTime
|
cutoffTime | True | string |
Tiempo límite del transportista en relación con el almacén. |
|
servingNodeIds
|
servingNodeIds | array of string |
Servir identificadores de nodo, que contiene una lista de identificadores de nodo a los que puede servir el operador actual. Una lista nula o vacía significa que este operador puede servir a cualquier nodo. |
Devoluciones
- response
- array of BulkResponseItemOfWarehouse
Crea una lista de pedidos de envío
Crea una lista de pedidos de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Identificador único de un pedido de envío. |
|
shipmentId
|
shipmentId | string |
Identificador de un envío que envía este pedido de envío. |
|
|
estado
|
status | string |
Estado del pedido de envío. |
|
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
estimatedCost
|
estimatedCost | True | double |
Costo estimado |
|
código de moneda
|
currencyCode | True | string |
El código de moneda |
|
customerId
|
customerId | string |
Id. de cliente |
|
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | True | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
|
isOpcional
|
isOptional | True | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
|
isFragile
|
isFragile | True | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | True | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del pedido de envío. |
|
|
customAttributes
|
customAttributes | object |
Información adicional del pedido de envío capturada como pares clave-valor. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
Crea una solicitud de oferta de envío
Crea una solicitud de oferta de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de oferta de envío.
|
shipmentQuoteRequestId | True | string |
Identificador de solicitud de oferta de envío. |
|
id
|
id | True | string |
Identificador único de una solicitud de oferta de envío. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad del artículo. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
|
|
shipmentVolume
|
shipmentVolume | True | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
|
shipmentLength
|
shipmentLength | True | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | True | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | True | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
|
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identificadores de oferta de envío correspondientes a la solicitud de oferta de envío |
|
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del envío. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del envío. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Devoluciones
Detalles de la solicitud de oferta de envío
- Body
- ShipmentQuoteRequest
Desencadena una ejecución para la instancia de flujo de salida de datos
Desencadena una ejecución para la instancia de flujo de datos para un nombre determinado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
|
dataOutflowName
|
dataOutflowName | string |
Obtiene o establece el nombre del flujo de datos. |
|
|
dataOutflowRunId
|
dataOutflowRunId | string |
Obtiene o establece el identificador de ejecución de flujo de salida de datos. |
|
|
runParams
|
runParams | object |
Obtiene o establece los parámetros específicos de un tipo de conector. |
|
|
estado
|
status | string |
Obtiene o establece el estado de ejecución de flujo de datos |
|
|
triggeredAt
|
triggeredAt | date-time |
Obtiene o establece el tiempo desencadenado para la ejecución del flujo de salida de datos. |
|
|
completedAt
|
completedAt | date-time |
Obtiene o establece la hora de finalización de la ejecución del flujo de salida de datos. |
|
|
triggeredBy
|
triggeredBy | string |
Obtiene o establece el mecanismo a través del cual se desencadenó esta ejecución. Actualmente a través de la API o el evento de finalización de ingesta de Datset. |
|
|
triggerId
|
triggerId | string |
Obtiene o establece el identificador del mecanismo de desencadenamiento. |
Devoluciones
- Body
- DataOutflowRun
Elimina el flujo de datos.
Elimina el flujo de datos para el nombre y el área de trabajo especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
Devoluciones
- Body
- DataInflow
Elimina el flujo de salida de datos.
Elimina el flujo de salida de datos para el nombre y el área de trabajo especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
Devoluciones
- Body
- DataOutflow
Elimina el nodo de entrega.
Elimina el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del nodo de entrega.
|
deliveryNodeId | True | string |
Identificador del nodo de entrega. |
Devoluciones
- response
- file
Elimina un almacén por identificador de almacenamiento
Elimina un almacén por identificador de almacén.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
Devoluciones
- response
- file
Elimina un conjunto de datos que tiene el nombre especificado.
Elimina un conjunto de datos que tiene el nombre especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del conjunto de datos.
|
name | True | string |
Nombre del conjunto de datos. |
Devoluciones
- Body
- Dataset
Elimina un elemento de almacenamiento por identificador de almacenamiento y sku de elementos.
Elimina un elemento de almacenamiento por identificador de almacenamiento y sku de elementos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
SKU de elemento.
|
itemSKU | True | string |
SKU de elemento. |
Devoluciones
- response
- file
Elimina un elemento para una SKU determinada.
Elimina un elemento para una SKU determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
SKU de elemento.
|
sku | True | string |
SKU de elemento. |
Devoluciones
- response
- file
Elimina un operador con el identificador de operador.
Elimina un operador con el identificador de operador de un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del operador.
|
carrierId | True | string |
Identificador del operador. |
Devoluciones
- response
- file
Elimina una lista de almacenes
Elimina una lista de almacenes para un identificador de área de trabajo determinado y una lista de identificadores de almacenamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
warehouseIds
|
warehouseIds | True | array of string |
Devoluciones
- response
- array of BulkResponseItemOfString
Elimina una lista de elementos de almacenamiento por identificadores de almacenamiento
Elimina una lista de elementos de almacenamiento por identificadores de almacenamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
itemSKUs
|
itemSKUs | True | array of string |
Devoluciones
- response
- array of BulkResponseItemOfString
Elimina una lista de elementos para las sku dadas.
Elimina una lista de elementos para las sku dadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
skus
|
skus | True | array of string |
Devoluciones
- response
- array of BulkResponseItemOfString
Elimina una lista de nodos de entrega.
Elimina los nodos de entrega de los identificadores de nodo de entrega especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
deliveryNodeIds
|
deliveryNodeIds | True | array of string |
Devoluciones
- response
- array of BulkResponseItemOfString
Enumeración de todas las ejecuciones para un flujo de datos determinado
Enumere todas las ejecuciones para el nombre de flujo de datos especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
Devoluciones
- response
- array of DataInflowRun
Enumeración de todas las ejecuciones para un flujo de salida de datos determinado
Enumere todas las ejecuciones para el nombre de flujo de salida de datos determinado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
Devoluciones
- response
- array of DataOutflowRun
Genera opciones de suministro
Genera opciones de suministro para el identificador de área de trabajo y la solicitud de suministro dadas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de pedido
|
orderId | True | string |
Número único que identifica un pedido. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
cantidad
|
quantity | True | integer |
Cantidad de elementos. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
La fecha y hora más tempranas en que se debe entregar el pedido. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Fecha y hora más reciente que se debe entregar el pedido. |
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
|
addressLine1
|
addressLine1 | True | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
|
cityName
|
cityName | True | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | True | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | True | string |
Nombre del país. |
|
postalCode
|
postalCode | True | string |
El código postal. |
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
|
maxNumOfFulfillmentOptions
|
maxNumOfFulfillmentOptions | True | integer | |
|
nombre
|
name | string |
Nombre del elemento. |
|
|
descripción
|
description | string |
Descripción del elemento. |
|
|
value
|
value | True | string |
Valor de código de barras. |
|
standardName
|
standardName | True | string |
Nombre estándar del código de barras. |
|
weight
|
weight | True | double |
Peso del elemento estándar. |
|
length
|
length | True | double |
Longitud del elemento estándar. |
|
Ancho
|
width | True | double |
Ancho del elemento estándar. |
|
profundidad
|
depth | True | double |
Profundidad del elemento estándar. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de medida de longitud, ancho y alto. |
|
abreviaturas
|
abbreviation | True | string |
Unidad de peso de medida. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
|
sku
|
sku | True | string |
Identificador de la unidad de mantenimiento de existencias, que normalmente se usa para las actividades relacionadas con el inventario. |
|
labels
|
labels | array of string |
Etiquetas |
|
|
warehouseId
|
warehouseId | string | ||
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Cantidad. |
|
itemSKU
|
itemSKU | True | string |
SKU del elemento. |
|
warehouseId
|
warehouseId | string |
SKU del elemento. |
|
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la última vez que se obtuvo este objeto WarehouseItem. |
|
|
nombre
|
name | True | string |
Nombre de la nota. |
|
value
|
value | True | string |
El valor de note. |
Devoluciones
Recupera el flujo de datos.
Recupera el flujo de datos para el nombre y el área de trabajo especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
Devoluciones
- Body
- DataInflow
Recupera el flujo de salida de datos.
Recupera el flujo de salida de datos para el nombre y el área de trabajo especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
Devoluciones
- Body
- DataOutflow
Recupera el suministro de pedidos por identificador de suministro de pedidos
Recupera el suministro de pedidos por identificador de suministro de pedidos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cumplimiento del pedido.
|
orderFulfillmentId | True | string |
Identificador de cumplimiento del pedido. |
Devoluciones
- Body
- OrderFulfillment
Recupera la ejecución de flujo de datos para el identificador de ejecución.
Recupera la ejecución de flujo de datos para un identificador de ejecución determinado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de datos.
|
name | True | string |
Nombre del flujo de datos. |
|
Identificador de ejecución de flujo de datos.
|
dataInflowRunId | True | string |
Identificador de ejecución de flujo de datos. |
Devoluciones
- Body
- DataInflowRun
Recupera los detalles de ejecución para el flujo de salida de datos y el identificador de ejecución especificados.
Recupera los detalles de ejecución para el nombre de flujo de salida de datos y el identificador de ejecución especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del flujo de salida de datos.
|
name | True | string |
Nombre del flujo de salida de datos. |
|
Objeto de ejecución de flujo de salida de datos.
|
dataOutflowRunId | True | string |
Objeto de ejecución de flujo de salida de datos. |
Devoluciones
- Body
- DataOutflowRun
Recupera los nodos de entrega para un área de trabajo determinada.
Recupera los nodos de entrega para un identificador de área de trabajo determinado.
Devoluciones
- response
- array of DeliveryNode
Recupera subdirectorios de un conjunto de datos.
Recupera subdirectorios de un conjunto de datos que tiene el nombre especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del conjunto de datos.
|
name | True | string |
Nombre del conjunto de datos. |
Devoluciones
- response
- array of Directory
Recupera todos los almacenes de un área de trabajo.
Recupera todos los conjuntos de datos de un área de trabajo.
Recupera todos los flujos de datos.
Recupera todos los flujos de datos de un área de trabajo determinada.
Devoluciones
- response
- array of DataInflow
Recupera todos los flujos de salida de datos de un área de trabajo.
Recupera todos los flujos de salida de datos para un área de trabajo determinada.
Devoluciones
- response
- array of DataOutflow
Recupera un almacén por identificador de almacenamiento
Recupera un almacén por identificador de almacenamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
Devoluciones
- Body
- Warehouse
Recupera un conjunto de datos que tiene el nombre especificado.
Recupera un conjunto de datos que tiene el nombre especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del conjunto de datos.
|
name | True | string |
Nombre del conjunto de datos. |
Devoluciones
- Body
- Dataset
Recupera un elemento
Recupera el elemento para el identificador de área de trabajo y la SKU especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
SKU de elemento.
|
sku | True | string |
SKU de elemento. |
Devoluciones
Algo que está inventariado. Una SKU, unidad de mantenimiento de stock, hace referencia a un elemento específico en una unidad de medida específica.
- Body
- Item
Recupera un elemento de almacenamiento por identificador de almacenamiento y sku de elementos.
Recupera un elemento de almacenamiento por identificador de almacenamiento y sku de elementos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del almacén.
|
warehouseId | True | string |
Identificador del almacén. |
|
SKU de elemento.
|
itemSKU | True | string |
SKU de elemento. |
Devoluciones
- Body
- WarehouseItem
Recupera un envío por identificador de envío
Recupera un envío por identificador de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de envío.
|
shipmentId | True | string |
Id. de envío. |
Devoluciones
Una cantidad de artículos, mercancías o carga masiva que se envían juntos.
- Body
- Shipment
Recupera un nodo de entrega
Recupera el nodo de entrega para el identificador de área de trabajo y el identificador de nodo de entrega especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del nodo de entrega.
|
deliveryNodeId | True | string |
Identificador del nodo de entrega. |
Devoluciones
Los detalles operativos de la ubicación de entrega, por ejemplo, ubicación, horas de operación, etc.
- Body
- DeliveryNode
Recupera un operador con el identificador de operador.
Recupera un operador con el identificador de operador de un área de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del operador
|
carrierId | True | string |
Identificador del operador. |
Devoluciones
- Body
- Carrier
Recupera un pedido de envío
Recupera un pedido de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del pedido de envío.
|
shipmentOrderId | True | string |
Identificador del pedido de envío. |
Devoluciones
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc.
- Body
- ShipmentOrder
Recupera un plan de cumplimiento
Recupera el plan de suministro para el identificador de área de trabajo y el identificador del plan de cumplimiento especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del plan de cumplimiento.
|
fulfillmentPlanId | True | string |
Identificador del plan de cumplimiento. |
Devoluciones
Las actividades previstas o reales relacionadas con el cumplimiento de una orden. Estas actividades pueden incluir la creación de listas de selección, la ejecución de la lista de selección, el empaquetado y el envío de los elementos al destino final.
- Body
- FulfillmentPlan
Recupera una cotización de envío
Recupera una cotización de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de oferta de envío.
|
shipmentQuoteId | True | string |
Id. de oferta de envío. |
Devoluciones
Detalles de la oferta de envío
- Body
- ShipmentQuote
Recupera una lista de planes de suministro con un estado de cumplimiento específico.
Recupera una lista de planes de suministro con un estado de suministro específico para el identificador de área de trabajo y el identificador de almacenamiento especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de almacenamiento.
|
warehouseId | string |
Identificador de almacenamiento. |
|
|
Estado de cumplimiento.
|
status | string |
Estado de cumplimiento. |
Devoluciones
- response
- array of FulfillmentPlan
Recupera una solicitud de oferta de envío
Recupera una solicitud de oferta de envío.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de oferta de envío.
|
shipmentQuoteRequestId | True | string |
Identificador de solicitud de oferta de envío. |
Devoluciones
Detalles de la solicitud de oferta de envío
- Body
- ShipmentQuoteRequest
Definiciones
Portador
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de un operador. |
|
tipo
|
type | string |
El tipo del operador, solo puede ser lo que admite OSCP. |
|
notas
|
notes | array of Note |
Id. de cuenta del lado del operador, id. de medidor, etc., que se usará al consultar al operador. |
Nota:
Un objeto genérico que contiene un par de valores de nombre, se puede usar para almacenar metadatos o propiedades que no son de primera clase.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Nombre de la nota. |
|
value
|
value | string |
El valor de note. |
DataInflow
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Obtiene o establece el nombre de flujo de datos Inmutable y único dentro de un área de trabajo. Este sería el identificador único de un flujo de datos. Proporcionado por el usuario como parámetro de dirección URL obligatorio. |
|
Nombre para mostrar
|
displayName | string |
Obtiene o establece el nombre para mostrar de Flujo de datos. |
|
datasetName
|
datasetName | string |
Obtiene o establece el nombre del conjunto de datos para el conector. |
|
conector
|
connector | Connector | |
|
transformador
|
transformer | Transformer | |
|
estado
|
state | string |
Obtiene o establece el estado de Flujo de datos. |
Conector
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
Tipo del conector. Ejemplo: CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | object |
Propiedades relativas al tipo de conector |
|
output
|
output | object |
Contiene los parámetros de salida que se mostrarían de vuelta al cliente. Por ejemplo, en el caso del conector FilterAndCopy, el identificador de invitación y la ubicación ads se devolverán como parte de la respuesta. |
Transformador
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
Tipo de transformador |
|
typeProperties
|
typeProperties | object |
Propiedades relativas al tipo de transformador |
DataInflowRun
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dataInflowName
|
dataInflowName | string |
Obtiene o establece el nombre de flujo de datos inmutable y único dentro de un área de trabajo. |
|
runParams
|
runParams | object |
Obtiene o establece los parámetros necesarios para la ejecución específica de un tipo de conector. |
|
dataInflowRunId
|
dataInflowRunId | string |
Obtiene o establece el identificador de ejecución de flujo de datos para la ejecución de flujo de datos. |
|
triggeredAt
|
triggeredAt | date-time |
Obtiene o establece el tiempo desencadenado para la ejecución de flujo de datos. |
|
completedAt
|
completedAt | date-time |
Obtiene o establece la hora de finalización de la ejecución de flujo de datos. |
|
estado
|
status | string |
Obtiene o establece el estado de ejecución de flujo de datos. |
Flujo de datos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Nombre de flujo de salida de datos que es inmutable y único dentro de un área de trabajo. Este sería el identificador único de un flujo de salida de datos. Proporcionado por el usuario como parámetro de dirección URL obligatorio. |
|
Nombre para mostrar
|
displayName | string |
Nombre para mostrar del flujo de datos. |
|
descripción
|
description | string |
Descripción del flujo de salida de datos. |
|
datasetName
|
datasetName | string |
Obtiene o establece el nombre del conjunto de datos para el conector. |
|
filteredEntities
|
filteredEntities | array of DataSchema |
Obtiene o establece el subconjunto de entidades que se van a exportar desde el conjunto de datos con nombre. Si se omite esta propiedad, se va a exportar de forma predeterminada todas las entidades. |
|
conector
|
connector | Connector | |
|
transformador
|
transformer | Transformer | |
|
estado
|
state | string |
Estado del flujo de salida de datos. |
DataSchema
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
attributes
|
attributes | array of DataSchemaAttribute |
DataSchemaAttribute
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
DataOutflowRun
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dataOutflowName
|
dataOutflowName | string |
Obtiene o establece el nombre del flujo de datos. |
|
dataOutflowRunId
|
dataOutflowRunId | string |
Obtiene o establece el identificador de ejecución de flujo de salida de datos. |
|
runParams
|
runParams | object |
Obtiene o establece los parámetros específicos de un tipo de conector. |
|
estado
|
status | string |
Obtiene o establece el estado de ejecución de flujo de datos |
|
triggeredAt
|
triggeredAt | date-time |
Obtiene o establece el tiempo desencadenado para la ejecución del flujo de salida de datos. |
|
completedAt
|
completedAt | date-time |
Obtiene o establece la hora de finalización de la ejecución del flujo de salida de datos. |
|
triggeredBy
|
triggeredBy | string |
Obtiene o establece el mecanismo a través del cual se desencadenó esta ejecución. Actualmente a través de la API o el evento de finalización de ingesta de Datset. |
|
triggerId
|
triggerId | string |
Obtiene o establece el identificador del mecanismo de desencadenamiento. |
Conjunto de datos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Obtiene o establece el nombre. |
|
dataSchema
|
dataSchema | array of DataSchema |
Obtiene o establece la colección de entidades que forman parte de este conjunto de datos. Actualmente, este campo es opcional, pero un cambio futuro lo hará necesario. |
|
isDisabled
|
isDisabled | boolean |
Obtiene o establece un valor que indica si obtiene o establece el valor isdisabled. |
|
operationalType
|
operationalType | string |
Obtiene o establece el tipo operativo : representa si los datos son transaccionales (Cosmos) o a largo plazo (ADLS) |
|
schemaReference
|
schemaReference | SchemaReference | |
|
labels
|
labels | array of string |
Etiquetas |
SchemaReference
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dataModelId
|
dataModelId | string |
Obtiene o establece el identificador del modelo de datos. |
|
dataModelVersion
|
dataModelVersion | string |
Obtiene o establece dataModelVersion |
|
dataModelType
|
dataModelType | string |
Obtiene o establece el dataModelType. |
Directorio
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ingestionTime
|
ingestionTime | string |
Obtiene o establece SnapshotTime. |
|
incrementType
|
incrementType | string |
Obtiene o establece incrementType |
DeliveryNode
Los detalles operativos de la ubicación de entrega, por ejemplo, ubicación, horas de operación, etc.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador del nodo. |
|
hoursOfOperations
|
hoursOfOperations | array of HoursOfOperation |
Una lista de tiempos de operación. |
|
location
|
location | Location |
Ubicación de una estructura física. |
|
labels
|
labels | array of string |
Etiquetas |
|
hora de última modificación
|
lastModifiedTime | date-time |
HoursOfOperation
Hora de operación en un día de la semana
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
dayOfWeekName
|
dayOfWeekName | string |
El día de la semana. |
|
startTime
|
startTime | string |
Hora de inicio. |
|
endTime
|
endTime | string |
Hora de finalización. |
Ubicación
Ubicación de una estructura física.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
timeZoneName
|
timeZoneName | string |
Identificador único de una zona horaria. |
|
addressLine1
|
addressLine1 | string |
Dirección principal. |
|
addressLine2
|
addressLine2 | string |
Dirección secundaria. |
|
cityName
|
cityName | string |
Componente "city" de una ubicación. |
|
stateName
|
stateName | string |
El estado o el nombre de la provincia. |
|
countryName
|
countryName | string |
Nombre del país. |
|
postalCode
|
postalCode | string |
El código postal. |
|
notas
|
notes | array of Note |
Lista de notas de ubicación. |
BulkResponseItemOfDeliveryNode
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | DeliveryNode |
Los detalles operativos de la ubicación de entrega, por ejemplo, ubicación, horas de operación, etc. |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | DeliveryNode |
Los detalles operativos de la ubicación de entrega, por ejemplo, ubicación, horas de operación, etc. |
ErrorObject
El código y el mensaje de detalle del error.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
El código del error. |
|
Mensaje
|
message | string |
Mensaje de error legible. |
BulkResponseItemOfString
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | string |
El objeto de respuesta de la acción masiva de tipo T. |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | string |
Objeto de solicitud de tipo T para la acción masiva. |
GenerateFulfillmentOptionsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
fulfillmentOptions
|
fulfillmentOptions | array of FulfillmentOption |
FulfillmentOption
La opción de cumplimiento.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
fulfillmentOptionId
|
fulfillmentOptionId | string |
Identificador de una opción de suministro. |
|
shipmentToLocation
|
shipmentToLocation | Location |
Ubicación de una estructura física. |
|
overallCost
|
overallCost | Amount |
Cantidad en moneda específica. |
|
earliestDeliveryTime
|
earliestDeliveryTime | string |
El tiempo de entrega más antiguo. |
|
latestDeliveryTime
|
latestDeliveryTime | string |
El tiempo de entrega más reciente. |
|
tiempo de expiración
|
expirationTime | string |
La hora de expiración de la opción de cumplimiento. |
|
fulfillmentPlans
|
fulfillmentPlans | array of FulfillmentPlan |
Una lista de planes de cumplimiento en esta opción de cumplimiento. |
Cantidad
Cantidad en moneda específica.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | double | |
|
divisa
|
currency | string |
FulfillmentPlan
Las actividades previstas o reales relacionadas con el cumplimiento de una orden. Estas actividades pueden incluir la creación de listas de selección, la ejecución de la lista de selección, el empaquetado y el envío de los elementos al destino final.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de un suministro. |
|
warehouseId
|
warehouseId | string |
Identificador único de un almacén. |
|
scheduledExecutionTime
|
scheduledExecutionTime | string | |
|
orderLines
|
orderLines | array of OrderLine |
Las líneas de pedido que se planean cumplir con el plan de suministro |
|
Envíos
|
shipments | array of Shipment |
Los envíos de un plan de cumplimiento |
|
estado
|
status | string |
Estado del plan de suministro. |
|
statusReason
|
statusReason | string | |
|
Tiempo de creación
|
creationTime | string |
Marca de tiempo que se creó el plan de suministro. |
OrderLine
Un documento o una comisión por parte del cliente para pedir el artículo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de pedido
|
orderId | string |
Número único que identifica un pedido. |
|
itemSKU
|
itemSKU | string |
SKU del elemento. |
|
cantidad
|
quantity | integer |
Cantidad de elementos. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
La fecha y hora más tempranas en que se debe entregar el pedido. |
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | string |
Fecha y hora más reciente que se debe entregar el pedido. |
Shipment
Una cantidad de artículos, mercancías o carga masiva que se envían juntos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de un envío. |
|
estado
|
status | string |
Estado del envío. |
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
La lista de identificadores de pedido de envío que atiende el envío. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Los datos de las ubicaciones del envío. Actualmente, solo admite el tipo de ubicación Origen y Destino. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Datos de empaquetado de envío con detalles de las medidas del paquete |
|
shipmentCharge
|
shipmentCharge | ShipmentCharge |
Detalles del cargo de envío |
|
shipmentReferenceData
|
shipmentReferenceData | ShipmentReferenceData |
Datos de referencia de envío que contiene los detalles para realizar el seguimiento del paquete. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Lista de artículos que se van a enviar como parte del envío. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
shipmentContentData
|
shipmentContentData | ShipmentContentData |
Datos de contenido de envío que indica la presencia de ciertos tipos de elementos como batería o frágiles. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del envío. |
|
customAttributes
|
customAttributes | object |
Información adicional de envío capturada como pares clave-valor. |
|
carrierName
|
carrierName | string |
Nombre del transportista del envío |
ShipmentLocation
Detalles de la ubicación de envío
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
shipmentNodeType
|
shipmentNodeType | string |
Tipo de nodo de envío. Actualmente, solo se admiten origen y destino. |
|
locationType
|
locationType | string |
El tipo Location representa si location es un almacén, un cliente, etc. |
|
contactName
|
contactName | string |
Nombre de contacto de una persona relacionada con la ubicación |
|
contactNumber
|
contactNumber | string |
Número de contacto de una persona relacionada con la ubicación |
|
location
|
location | Location |
Ubicación de una estructura física. |
|
customAttributes
|
customAttributes | object |
Información adicional de ubicación de envío capturada como pares clave-valor. |
ShipmentPackingData
Datos de empaquetado de envío con detalles de las medidas del paquete
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
shipmentVolume
|
shipmentVolume | double |
El volumen |
|
shipmentNetWeight
|
shipmentNetWeight | double |
Peso |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Unidad de volumen de medida |
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Unidad de peso de medida |
|
shipmentLength
|
shipmentLength | double |
Longitud |
|
shipmentWidth
|
shipmentWidth | double |
Ancho |
|
shipmentHeight
|
shipmentHeight | double |
Alto |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Unidad de medida de longitud, ancho y alto |
|
shipmentPackingType
|
shipmentPackingType | string |
Tipo de embalaje de envío |
ShipmentCharge
Detalles del cargo de envío
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
estimatedCost
|
estimatedCost | double |
Costo estimado |
|
código de moneda
|
currencyCode | string |
El código de moneda |
|
billingData
|
billingData | BillingData |
Detalles de facturación |
|
componentCharges
|
componentCharges | array of ComponentCharge |
Los datos de cargos del componente |
BillingData
Detalles de facturación
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
customerId
|
customerId | string |
Id. de cliente |
|
nombreDelCliente
|
customerName | string |
El nombre del cliente |
|
customAttributes
|
customAttributes | object |
Información adicional de datos de facturación capturada como pares clave-valor |
ComponentCharge
Datos de cargo de componentes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
totalComponentCharge
|
totalComponentCharge | double |
Cargo total |
|
chargeTypeId
|
chargeTypeId | string |
Identificador del tipo de cargo |
|
chargeTypeName
|
chargeTypeName | string |
Nombre del tipo de cargo |
|
isOpcional
|
isOptional | boolean |
La marca IsOptional se establece en True si los cargos relacionados con el componente son opcionales. Else False |
ShipmentReferenceData
Datos de referencia de envío que contiene los detalles para realizar el seguimiento del paquete.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
trackingNumber
|
trackingNumber | string |
Número de seguimiento |
|
trackingUrl
|
trackingUrl | string |
Dirección URL de seguimiento |
|
shipLabelUrl
|
shipLabelUrl | string |
Dirección URL de etiqueta de envío |
ShipmentItem
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
itemSKU
|
itemSKU | string |
SKU del elemento. |
|
cantidad
|
quantity | integer |
Cantidad del artículo. |
ShipmentContentData
Datos de contenido de envío que indica la presencia de ciertos tipos de elementos como batería o frágiles.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
isFragile
|
isFragile | boolean |
La marca IsFragile se establece en true si existen elementos frágiles. En caso contrario, False . |
|
includesBattery
|
includesBattery | boolean |
La marca IncludesBattery se establece en true si la batería forma parte del paquete. En caso contrario, False . |
Elemento
Algo que está inventariado. Una SKU, unidad de mantenimiento de stock, hace referencia a un elemento específico en una unidad de medida específica.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Nombre del elemento. |
|
descripción
|
description | string |
Descripción del elemento. |
|
códigos de barras
|
barcodes | array of Barcode |
Lista de códigos de barras del elemento. |
|
weight
|
weight | double |
Peso del elemento estándar. |
|
length
|
length | double |
Longitud del elemento estándar. |
|
Ancho
|
width | double |
Ancho del elemento estándar. |
|
profundidad
|
depth | double |
Profundidad del elemento estándar. |
|
abreviaturas
|
lwhUnitOfMeasure.abbreviation | string |
Unidad de medida de longitud, ancho y alto. |
|
abreviaturas
|
weightUnitOfMeasure.abbreviation | string |
Unidad de peso de medida. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
|
sku
|
sku | string |
Identificador de la unidad de mantenimiento de existencias, que normalmente se usa para las actividades relacionadas con el inventario. |
|
labels
|
labels | array of string |
Etiquetas |
Código de barras
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | string |
Valor de código de barras. |
|
standardName
|
standardName | string |
Nombre estándar del código de barras. |
WarehouseItem
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
availableToPromiseQuantity
|
availableToPromiseQuantity | integer |
Cantidad. |
|
itemSKU
|
itemSKU | string |
SKU del elemento. |
|
warehouseId
|
warehouseId | string |
SKU del elemento. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la última vez que se obtuvo este objeto WarehouseItem. |
BulkResponseItemOfItem
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | Item |
Algo que está inventariado. Una SKU, unidad de mantenimiento de stock, hace referencia a un elemento específico en una unidad de medida específica. |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | Item |
Algo que está inventariado. Una SKU, unidad de mantenimiento de stock, hace referencia a un elemento específico en una unidad de medida específica. |
OrderFulfillment
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
orderLines
|
orderLines | array of OrderLine | |
|
shipmentToLocation
|
shipmentToLocation | Location |
Ubicación de una estructura física. |
|
shipmentToName
|
shipmentToName | string | |
|
shipmentReceiverContact
|
shipmentReceiverContact | string | |
|
estado
|
status | string | |
|
id
|
id | string | |
|
fulfillmentPlanIds
|
fulfillmentPlanIds | array of string | |
|
Tiempo de creación
|
creationTime | date-time | |
|
hora de última modificación
|
lastModifiedTime | date-time | |
|
notas
|
notes | array of Note |
ShipmentOrder
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de un pedido de envío. |
|
shipmentId
|
shipmentId | string |
Identificador de un envío que envía este pedido de envío. |
|
estado
|
status | string |
Estado del pedido de envío. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Los artículos de envío que forman parte del pedido de envío. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Los datos de las ubicaciones del pedido de envío. Actualmente, solo admite el tipo de ubicación Origen y Destino. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Datos de empaquetado de envío con detalles de las medidas del paquete |
|
shipmentCharge
|
shipmentCharge | ShipmentCharge |
Detalles del cargo de envío |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del pedido de envío. |
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
La hora de recogida más temprana planeada del pedido de envío. |
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
La hora de recogida más reciente planeada del pedido de envío. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del pedido de envío. |
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
La hora de entrega más temprana planeada del pedido de envío. |
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
El tiempo de entrega más reciente planeado del pedido de envío. |
|
shipmentContentData
|
shipmentContentData | ShipmentContentData |
Datos de contenido de envío que indica la presencia de ciertos tipos de elementos como batería o frágiles. |
|
deliveryInstructions
|
deliveryInstructions | object |
Las instrucciones de entrega del pedido de envío. |
|
customAttributes
|
customAttributes | object |
Información adicional del pedido de envío capturada como pares clave-valor. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
BulkResponseItemOfShipmentOrder
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | ShipmentOrder |
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc. |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | ShipmentOrder |
El Pedido de envío con detalles como artículos que se van a enviar, información de ubicaciones de origen/destino, cargos, etc. |
ShipmentQuote
Detalles de la oferta de envío
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de una cotización de envío. |
|
shipmentQuoteRequestId
|
shipmentQuoteRequestId | string |
El identificador de la solicitud de oferta de envío a la que está relacionada la cotización de envío. |
|
shipmentCharge
|
shipmentCharge | ShipmentCharge |
Detalles del cargo de envío |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del envío. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del envío. |
|
carrierData
|
carrierData | CarrierData |
Datos del operador |
|
customAttributes
|
customAttributes | object |
Información adicional de la oferta de envío capturada como pares clave-valor. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
CarrierData
Datos del operador
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
carrierId
|
carrierId | string |
Id. de operador |
|
carrierName
|
carrierName | string |
Nombre del operador |
ShipmentQuoteRequest
Detalles de la solicitud de oferta de envío
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único de una solicitud de oferta de envío. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Los artículos de envío que forman parte del pedido de envío. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Los datos de las ubicaciones correspondientes a la solicitud de oferta de envío. Actualmente, solo admite el tipo de ubicación Origen y Destino. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Datos de empaquetado de envío con detalles de las medidas del paquete |
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identificadores de oferta de envío correspondientes a la solicitud de oferta de envío |
|
plannedPickupTime
|
plannedPickupTime | string |
Hora prevista de recogida del envío. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
El tiempo de entrega planeado del envío. |
|
hora de última modificación
|
lastModifiedTime | date-time |
Obtiene o establece la hora que se ha modificado por última vez. |
Almacén
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador del nodo. |
|
hoursOfOperations
|
hoursOfOperations | array of HoursOfOperation |
Una lista de tiempos de operación. |
|
location
|
location | Location |
Ubicación de una estructura física. |
|
labels
|
labels | array of string |
Etiquetas |
|
hora de última modificación
|
lastModifiedTime | date-time | |
|
pickAndPackLeadTime
|
pickAndPackLeadTime | integer |
Obtiene o establece pickAndPackLeadTime, que es el número de horas que requiere Warehouse para seleccionar y empaquetar el elemento. |
|
carrierReferences
|
carrierReferences | array of CarrierReference |
La lista de información del operador |
CarrierReference
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
carrierId
|
carrierId | string |
Id. de operador asociado |
|
cutoffTime
|
cutoffTime | string |
Tiempo límite del transportista en relación con el almacén. |
|
servingLocations
|
servingLocations | array of Location |
Ubicaciones de servicio que contiene una lista de códigos postales a los que puede servir el operador actual. Una lista nula o vacía significa que este operador puede servir a cualquier código postal. |
|
servingNodeIds
|
servingNodeIds | array of string |
Servir identificadores de nodo, que contiene una lista de identificadores de nodo a los que puede servir el operador actual. Una lista nula o vacía significa que este operador puede servir a cualquier nodo. |
BulkResponseItemOfWarehouse
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | Warehouse | |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | Warehouse |
BulkResponseItemOfWarehouseItem
El objeto de respuesta masiva genérico de tipo T
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado de respuesta de la acción masiva. |
|
response
|
response | WarehouseItem | |
|
error
|
error | ErrorObject |
El código y el mensaje de detalle del error. |
|
request
|
request | WarehouseItem |
archivo
Este es el tipo de datos básico "file".