Metadata
Basic Metadata
- Type:
- Specifies the job type character:
- ▪ d for MegaEdit.
- ▪ s for Static PDF files.
- ▪ m for Upload and MultiPart editor files.
- Job ID:
- The identifier for the job as a number only.
- Order ID:
- The identifier for the order.
- Full Job ID:
- The identifier including type as a storefront-wide unique identification.
- Mode:
- Specifies how the job got into the system (Polling or Webhooks).
InfigoAdvancedMetaData
Definition: This interface represents the advanced metadata structure provided by Infigo Connect.
export interface InfigoAdvancedMetaData {
order?: InfigoOrderMetaData,
lineItem?: InfigoOrderlineMetaData,
customer?: InfigoCustomerMetaData,
impersonator?: InfigoCustomerMetaData,
storefrontName: string
}
• order: Metadata about the order (optional).
• lineItem: Metadata about the order line item (optional).
• customer: Metadata about the customer (optional).
• impersonator: Metadata about the impersonator (optional).
• storefrontName: Name of the storefront (required).
InfigoOrderMetaData
Definition: This interface represents detailed metadata about an order.
export interface InfigoOrderMetaData {
orderId: number,
orderGuid: string,
payment: InfigoPaymentMetaData,
orderStatus: OrderStatus,
paymentStatus: PaymentStatus,
shippingStatus: ShippingStatus,
shippingMethod: string,
shippingMethodExternalId: string,
paymentMethod: string,
paymentTransactionId: string,
vatNumber: string,
orderWeight: number,
purchaseOrderNumber: string,
orderNotes: string[],
orderDate: string,
dispatchBy: string,
deliverBy: string,
billingAddress?: InfigoAddressMetaData,
shippingAddress?: InfigoAddressMetaData,
extraData: Record<string, string>,
checkoutAttributes: InfigoAttribute[]
}
• orderId: The unique identifier for the order.
• orderGuid: The globally unique identifier for the order.
• payment: Metadata about the payment (see InfigoPaymentMetaData).
• orderStatus: The current status of the order.
• paymentStatus: The status of the payment.
• shippingStatus: The status of the shipping.
• shippingMethod: The shipping method used.
• shippingMethodExternalId: The external ID for the shipping method.
• paymentMethod: The payment method used.
• paymentTransactionId: The transaction ID for the payment.
• vatNumber: The VAT number associated with the order.
• orderWeight: The weight of the order.
• purchaseOrderNumber: The purchase order number.
• orderNotes: Notes associated with the order.
• orderDate: The date the order was placed.
• dispatchBy: The date by which the order should be dispatched.
• deliverBy: The date by which the order should be delivered.
• billingAddress: Metadata about the billing address (optional).
• shippingAddress: Metadata about the shipping address (optional).
• extraData: Additional data related to the order.
• checkoutAttributes: Attributes related to the checkout process.
InfigoAddressMetaData
Definition: This interface represents detailed metadata about an address.
export interface InfigoAddressMetaData {
externalId: string,
email: string,
firstName: string,
lastName: string,
phoneNumber: string,
company: string,
addressLine1: string,
addressLine2: string,
town: string,
county: string,
country: string,
countryCode: string,
zipCode: string,
fax: string
}
• externalId: The external ID for the address.
• email: The email address.
• firstName: The first name.
• lastName: The last name.
• phoneNumber: The phone number.
• company: The company name.
• addressLine1: The first line of the address.
• addressLine2: The second line of the address (optional).
• town: The town or city.
• county: The county or region.
• country: The country.
• countryCode: The country code.
• zipCode: The postal code.
• fax: The fax number (optional).
InfigoCustomerMetaData
Definition: This interface represents detailed metadata about a customer.
export interface InfigoCustomerMetaData {
infigoId: number,
externalId: string,
details: InfigoAddressMetaData
}
• infigoId: The unique identifier for the customer within Infigo.
• externalId: The external ID for the customer.
• details: Metadata about the customer's address (see InfigoAddressMetaData).
InfigoPaymentMetaData
Definition: This interface represents detailed metadata about a payment.
export interface InfigoPaymentMetaData {
totalPrice: number,
taxes: number,
discount: number,
subTotalDiscountInclTax: number,
subTotalDiscountExclTax: number,
shippingTax: number,
shippingPrice: number,
currency: string,
}
• totalPrice: The total price of the order.
• taxes: The total taxes applied to the order.
• discount: The total discount applied to the order.
• subTotalDiscountInclTax: The subtotal discount including tax.
• subTotalDiscountExclTax: The subtotal discount excluding tax.
• shippingTax: The tax applied to shipping.
• shippingPrice: The price of shipping.
• currency: The currency used for the payment.
InfigoAttribute
Definition: This interface represents an attribute with a key-value pair.
export interface InfigoAttribute {
externalId: string,
key: string,
value: string
}
• externalId: The external ID for the attribute.
• key: The key of the attribute.
• value: The value of the attribute.
InfigoOrderlineMetaData
Definition: This interface represents detailed metadata about an order line item.
export interface InfigoOrderlineMetaData {
orderlineId: string,
externalId: string,
attributeCombinationExternalId: string,
infigoProductId: number,
sku: string,
productName: string,
customName: string,
shortDescription: string,
description: string,
quantity: number,
unitPrice: number,
totalPrice: number,
totalTax: number,
weight: number,
discountAmountInclTax: number,
discountAmountExclTax: number,
extraData: Record<string, string>,
productAttributes: InfigoAttribute[],
specificationAttributes: InfigoAttribute[]
}
• orderlineId: The unique identifier for the order line item.
• externalId: The external ID for the order line item.
• attributeCombinationExternalId: The external ID for the attribute combination.
• infigoProductId: The Infigo product ID.
• sku: The stock keeping unit.
• productName: The name of the product.
• customName: The custom name for the product.
• shortDescription: A short description of the product.
• description: A detailed description of the product.
• quantity: The quantity of the product ordered.
• unitPrice: The unit price of the product.
• totalPrice: The total price for the order line item.
• totalTax: The total tax applied to the order line item.
• weight: The weight of the order line item.
• discountAmountInclTax: The discount amount including tax.
• discountAmountExclTax: The discount amount excluding tax.
• extraData: Additional data related to the order line item.
• productAttributes: A list of product attributes (see InfigoAttribute).
• specificationAttributes: A list of specification attributes (see InfigoAttribute).