External API Documentation

README.md

External API

Order JSON schema

{
  createdAt: DateTime, // ISO 8601
  orderId: string,
  lineItems: [
    {
      sku: string,
      name: string, // Product variant name
      quantity: number,
      // Price before discount applied
      price: {
        amount: number, // In cents $20.00 = 2000
        currencyCode: string, // ISO 4217 codes
      },
      // 0 if no discount applied
      discountAmount: {
        amount: number, // In cents $20.00 = 2000
        currencyCode: string, // ISO 4217 codes
      },
      // Same as price if no discount applied
      priceAfterDiscount: {
        amount: number, // In cents $20.00 = 2000
        currencyCode: string, // ISO 4217 codes
      },
    },
  ],
  // Subtotal order price including discounts, excluding shipping, taxes and duties
  subtotalPrice: {
    amount: number, // In cents $20.00 = 2000
    currencyCode: string,
  },
  firstName: string,
  lastName: string,
  email: string,
  address1: string,
  address2: string,
  city: string,
  zip: string,
  state: string,
  country: string,
  phone: string,
  countryCode: string,
};

Tracking number JSON Schema

{
    orderId: string,
    trackingNumber: string,
    returnTrackingNumber: string
}