ChannelApe Order

This is a list of supported fields on an order within ChannelApe and how they are used.

Order

The general information about the order.

Name Purpose Type Required for Create Required for Update
id The identifier of the order for ChannelApe. String No Yes
alphabeticCurrencyCode Currency of money used for order String Yes Yes
businessId The business ID associated with the order String Yes Yes
cancelededAt The time that the order was canceled. ISO8601 DateTime No No
canceledReason The reason the order was canceled. String No No
channelId The id of the channel associated with this order. String Yes N/A
channelOrderId The id of the order on the specified channel. (AmazonOrderID, Shopify order ID)

This must be unique across all orders for a business. This can’t be changed on an update.

String Yes N/A
createdAt The time the order was created in ChannelApe. This is set automatically by ChannelApe when the order is created. String N/A N/A
customer The customer associated with the order. Customer No No
fulfillments Any fulfillment(s) associated with the order. List of Fulfillments No No
refunds Any refunds(s) associated with the order. List of Refunds No No
lineItems Any line item(s) associated with the order List of LineItems Yes Yes
purchasedAt The time the order was placed within the specified Channel. (Shopify, Amazon, Bigcommerce) ISO8601 DateTime Yes Yes
purchaseOrderNumber The PO Number for an order. Usually shared between customer and warehouse. Varies by channel. String no no
String Yes Yes
status The status of the order. The valid values are:

  • OPEN – Order was pulled in from the Channel. ChannelApe has yet to do anything with it yet.
  • IN_PROGRESS – The order was sent to your supplier and ChannelApe is awaiting a response.
  • CLOSED – Fulfillment information has been received and pushed to Channel or the Order has been fulfilled on the Channel and updated in ChannelApe.
  • CANCELED – Order has been canceled on the Channel and is updated within ChannelApe.
  • PENDING – Order has not yet been paid for on the channel yet, but has enough info to pull into ChannelApe.
  • HOLD – Order was flagged because it needs additional updates before being fulfilled.
subtotalPrice Price of the order before shipping and taxes. Could be provided by the channel. Float No No
totalGrams Weight in grams of all the items in the order. ChannelApe does not automatically calculate just based on total line items. This could be provided by the channel. Float No No
totalPrice Total price provided by the channel. Float No No
totalShippingPrice Total Shipping Price provided by the channel. Float No No
totalShippingTax Total Shipping Tax provided by the channel. Float No No
totalTax Total Tax Tax that could be provided by the channel. Float No No
updatedAt The time that the order was last updated in ChannelApe. This is set automatically by ChannelApe when the order is updated. ISO8601 DateTime N/A N/A
additionalFields Additional Fields are used as fields that may be channel specific and don’t fit into the schema of an order that needs to be pulled or pushed to and from the channel. Please check the channel documentation to find what additional fields are supported for that Channel. List of Additional Fields No No

Line Item

The line items of an order or fulfillment. The line items of an order or fulfillment do not have to exist in ChannelApe.

Name Purpose Type Required for Create Required for Update
id The identifier of the Line Item on the order for ChannelApe. String Yes Yes
sku Stock Keeping Unit for the item. String No No
upc Universal Product Code for the item. String No No
quantity The amount order of the specific line item. Integer Yes Yes
price The price of the specific line item. Float Yes Yes
title The title of the specific line item. String No No
vendor The vendor of the specific line item. String No No
grams The weight in grams of the specific line item. Float No No
shippingPrice The cost of shipping for the specific line item. Float No No
shippingTax The cost of shipping taxes for the specific line item. Float No No
shippingMethod The method of shipping for the specific line item. String No No
giftCardId The identifier of the Gift Card for ChannelApe. String No No
giftCardCode The code to redeem a gift card. String No No
additionalFields Additional Fields are used as fields that may be channel specific and don’t fit into the schema of a line item that needs to be pulled or pushed to and from the channel. Please check the channel documentation to find what additional fields are supported for that Channel. List of Additional Fields No No

Fulfillment

Fulfillments are information about items that have been fulfilled by the supplier for the order. ChannelApe takes the fulfillment from a supplier and pushes them to the channel the order came from.

Name Purpose Type Required for Create Required for Update
id The identifier of the fulfillment on the order for ChannelApe. String No No
supplierId The identifier of the supplier for the fulfillment on the order for ChannelApe. Used for order automation String No No
status The status of the fulfillment. The valid values are:

  • OPEN – Fulfillment has been created but not yet sent to the supplier.
  • PENDING – Supplier Integration has sent the order to the supplier and has received a fulfillment back without tracking information. It remains even when the integration updates the fulfillment with the tracking data. The fulfillment goes to SUCCESS when we push the fulfillment with tracking information to the channel.
  • SUCCESS – Fulfillment with tracking info has been fully updated in the channel.
  • CANCELED – The fulfillment can be fulfilled.
String Yes Yes
lineItems The line items being fulfilled. List of LineItem Yes Yes
shippingCompany The shipping company that fulfilled these line items. String No No
shippingMethod The method of shipping for these line items on the fulfillment. String No No
trackingNumber The tracking number fulfillment. String No No
trackingUrls A list of tracking urls the user can use to track this fulfillment. List of Strings No No
shippedAt The time the fulfillment was shipped by the supplier. Defaults to current time if no value is provided when creating a fulfillment. ISO8601 DateTime No No
additionalFields Additional Fields are used as fields that may be channel specific and don’t fit into the schema of a fulfillment that need to be pulled or pushed to and from the channel. Please check the channel documentation to find what additional fields are supported for that Channel. List of Additional Fields No No

Refund

Refunds are used to cancel line items on an order.

Name Purpose Type Required for Create Required for Update
supplierRefundId The identifier of the refund if it came from a supplier on the order for ChannelApe. String No No
channelRefundId The identifier of the refund if it was pushed to a channel on the order for ChannelApe. String No No
lineItems The line items being fulfilled. List of LineItem Yes Yes

Customer

The information about the customer that placed the order on the channel.

Name Purpose Type Required for Create Required for Update
name Some channels like Amazon only provide one string for the name instead of first and last name. This can be hard to split apart, therefore, this field should be used on those channels instead. String No No
firstName The first name of the customer that placed the order. String No No
lastName The last name of the customer that placed the order. String No No
email The email of the customer that placed the order. String No No
phone The phone number of the customer that placed the order. String No No
shippingAddress The shipping address of the customer that placed the order. Address No No
billingAddress The billing address of the customer that placed the order. Address No No
additionalFields Additional Fields are used as fields that may be channel specific and don’t fit into the schema of a customer that needs to be pulled or pushed to and from the channel. Please check the channel documentation to find what additional fields are supported for that Channel. List of Additional Fields No No

Address

The Address information for the customer that placed the order.

Name Purpose Type Required for Create Required for Update
name Name of the address. String No No
firstName The first name of the customer that placed the order. String No No
lastName The last name of the customer that placed the order. String No No
company The company located at the address. String No No
address1 The first line of the address. String No No
address2 The second line of the address. String No No
city The city where the address is located. String No No
province The province or state where the address is located. String No No
provinceCode The province or state code where the address is located. String No No
country The country where the address is located. String No No
countryCode The country code where the address is located. String No No
postalCode The postal or zip code where the address is located. String No No
phone The phone number associated with the address. String No No
additionalFields Additional Fields are used as fields that may be channel specific and don’t fit into the schema of an address that needs to be pulled or pushed to and from the channel. Please check the channel documentation to find what additional fields are supported for that Channel. List of Additional Fields No No

Additional Field

Name Purpose Type Required for Create Required for Update
name Key of the additional field. String No No
value Value of the additional field. String No No
Tagged: