Órdenes V1

hasVirtualProducts boolean

true Si la orden posee productos virtuales como: cursos, entradas, capacitaciones, ebooks

isVirtual boolean

true Si la orden posee únicamente productos viruales. Esto quiere decir que la orden no va a contener el objeto Shipping

isGift boolean

true Si la orden es marcada como regalo

usedMagicLink boolean

true Si la orden fué realizada utilizando un magic link

store object

id string | null

Indentificador único para autogenerado o autoincrementado para el detalle de envío

latitude float | null

Punto cardinal geográfico de latitud usualmente proporcionado por google maps

longitude float | null

Punto cardinal geográfico de longitud usualmente proporcionado por google maps

country string

alpha-2 Código de país

state string

Region, Provincia o Estado depende del country asignado

city string

Ciudad, Cantón o Municipio depende del country y state asignado

district string

Distrito depende country,state y city asignados

label string | null

Etiqueta para almacenar la dirección con un texto representativo

details string | null

Notas del envío o cualquier dato importante como por ejemplo :

• “Cuidado con el perro”
• “Es la casa de portón Negro”
• “Dejar en la puerta del depa A32”

company string | null

Nombre de negocio o comercio en caso de ser requerido

method string

The selection of shipping made by the user or sales channel

methodCode string

The method code selection of shipping made by the user or sales channel.

Posibles valores:

'redlogistic_urbano'
'redlogistic_rural'
'redlogistic_especial'
'moovin_ondemand'
'moovin_route'
'correoscr_rural'
'correoscr_urbano'
'nuevenuevemin_1'
'nuevenuevemin_2'
'nuevenuevemin_3'
'nuevenuevemin_4'
'enviaya_delivery'
'freeshipping_freeshipping'
'freeshipping_freeshipping0'
'flatrate_flatrate'
'flatrate_flatrate0'
'flatrate_flatrate1'
'flatrate_flatrate2'
'lalamove_MOTORCYCLE'
'pos_pos'

dni string

Identificador único de gobierno depende del país y si es requerido por alguna integración

Costa Rica: 116640278

México: CUPU800825569

hasGeneratedDocument boolean

true Si la guía de envío o etiqueta de entrega ya fué generada en caso de que la integración de envío lo requiera

document string| null

Si hasGeneratedDocument = true entonces el url del documento se encontrará en este atributo comunmente el documento generado es un PDF

telephone string

Telephone number asigned to the shipping address

deliveryDay string

Day of the week that the order was delivered

Posibles valores:

'Lunes'
'Martes'
'Miércoles'
'Jueves'
'Viernes'
'Sábado'
'Domingo'

id string | null

Indentificador único para autogenerado o autoincrementado para el detalle de facturación

latitude float | null

Punto cardinal geográfico de latitud usualmente proporcionado por google maps

longitude float | null

Punto cardinal geográfico de longitud usualmente proporcionado por google maps

country string

alpha-2 Código de país

state string

Region, Provincia o Estado depende del country asignado

city string

Ciudad, Cantón o Municipio depende del country y state asignado

district string

Distrito depende country,state y city asignados

label string | null

Etiqueta para almacenar la dirección con un texto representativo

details string | null

Notas del envío o cualquier dato importante generado por el comercio como por ejemplo :

• “Facturación de compañía”
• “Orden empresarial”

company string | null

Nombre de negocio o comercio en caso de ser requerido

dni string

Identificador único de gobierno depende del país y si es requerido por alguna integración de facturación

Costa Rica: 116640278

México: CUPU800825569

government object

telephone string

Telephone number asigned to the shipping address

id string

Identificador único para el descuento creado

total float

Total a descontar de la orden en el descuento

code string

Código único para el descuento ejemplo: DIADELPADRE,BLACKFRIDAY

subtotal float

Suma total productos en la orden antes de impuestos, envío y descuentos.

total float

Costo total de la orden incluyendo impuestos, envío y descuentos

baseCurrencyCode string

Código de moneda base del comercio o tienda en formato ISO 4217

orderCurrencyCode string

Código de moneda utilizado en la orden en formato ISO 4217

baseToOrderRate float

Tipo de cambio utilizado para la orden en caso de que baseCurrencyCode y orderCurrencyCode sean iguales entonces baseToOrderRate será igual a 1

tax objeto

En caso de tener impuestos este atributo muestra el total a rebajar del subtotal

hasFreeShippingProducts boolean

true si en los productos alguno fué marcado como freeShipping true

handlingFee float

Si el sistema de envío lo permite puede existir un handlingFee que describe el costo de manejo de paquete usualmente para envíos de tipo carga pesada

shipping object

Objeto que describe los costos de shipping o envío de la orden

deductions object | null

En caso de utilizar el sistema o gateway de pagos de Avify algunas deducciones pueden aplicar así también como algún costo extra de orden por el plan asignado a la suscripción de la cuenta utilizada

method string

Método de pago utilizado para la orden

status string

Estado del pago en la orden

wasRefunded float

true si hubo algún retorno de pago

refund float

En caso de wasRefunded = true la cantidad a retornar al customer de la orden

bankTransferMethod string | null

En caso de ser una transacción por transferencia bancaria el método de transferencia se mostrará en este campo

reference string

Identificador del pago que hace referencia al sistema de pagos utilizado.

hasReceipt boolean

true si existe un recibo de pago adjuntado a la orden

receipt object| null

wasNotified boolean

truesi al crear la nota esta fué notificada al customer

comment string

Texto o comentario asignado a la orden

created Date

Fecha de creación de la nota en formato ISO-8601 String

createdTimestamp string

Fecha de creación de la nota en formato Unix Epoch Timestamp

export interface OrderAdressV1 {
  id?: string;
  latitude?: number;
  longitude?: number;
  country: string;
  state: string;
  city: string;
  district: string;
  street: string;
  postcode: string;
  label?: string;
  details?: string;
  company?: string;
  dni?: string;
}
export interface OrderShippingV1 extends OrderAdressV1 {
  hasGeneratedDocument: boolean;
  document?: string;
}
export interface OrderBillingV1 extends OrderAdressV1 {
  goverment: {
    documents: {
      id: string;
      document: string;
      metadata?: string;
    }[];
    log: string;
  };
}
export interface TaxV1 {
  total: number;
  percentage?: number;
  id?: string;
  name?: string;
}
export interface OrderV1 {
  id: string;
  status: string;
  channel: string;
  created: Date;
  createdTimestamp: string;
  updated: Date;
  updatedTimestamp: string;
  details: {
    hasVirtualProducts: boolean;
    isVirtual: boolean;
    isGift: boolean;
    usedMagicLink: boolean;
  };
  avify: {
    store: {
      name: string;
      uuid: string;
    };
  };
  customer: {
    id?: string;
    email: string;
    firstName: string;
    lastName: string;
    gender?: string;
    telephone?: string;
    company?: string;
  };
  shipping?: OrderShippingV1;
  billing?: OrderBillingV1;
  discount: {
    total: number;
    id?: string;
    code?: string;
  };
  costs: {
    subtotal: number; //before taxes, discounts and shipping
    total: number;
    tax: {
      total: number;
    };
    hasFreeShippingProducts: boolean;
    shipping: {
      subtotal: number;
      total: number;
      tax: TaxV1;
      handlingFee: number;
    };
    baseCurrencyCode: string; // Currency used back in the store
    orderCurrencyCode: string; // Currency used in the order
    baseToOrderRate: number; // If BCC and OCC are the same BTR is 1
    deductions?: {
      flatFee: number; // Cost per transaction
      percentageFee: number; // Percentage of the subtotal if payment method is credit card
      isOverflowOrder: boolean; // If you pass your order limit you will be charged an extra fee
      overflowFee: number; //The total fee charge in that specific time frame
    };
  };
  payment: {
    method: string;
    status: string;
    wasRefunded: boolean;
    refund: number;
    hasReceipt: boolean;
    bankTransferMethod?: string;
    reference?: string;
    receipt?: {
      id?: string;
      url: string;
    };
  };
  notes: {
    wasNotified: boolean;
    comment: string;
    createdTimestamp: string;
    created: Date;
  }[];
  products: any[];
  metadata?: { [key: string]: number | string | boolean }; // Max 100kb
}