ShipStation Integration: Field-Mapping
The following table lists the fields that are mapped between Chargebee and ShipStation when the integration is enabled and orders are synced.
| Serial # | Chargebee Field | ShipStation Field |
|---|---|---|
| 1 | document_number | orderNumber |
| 2 | reference_id | orderKey |
| 3 | order_date | orderDate |
| 4 | paid_at | paymentDate |
| 5 | fulfillment_status | orderStatus |
| 6 | status | No direct mapping. Field value in Chargebee is assigned based on the value of order status in ShipStation. See this table . |
| 7 | shipped_at | shipDate |
| 8 | delivered_at | fullfillments[deliveryDate] |
| 9 | tracking_id | shipments[trackingNumber] |
| 10 | batch_id | shipments[batchNumber] |
| 11 | shipment_carrier | shipments[carrierCode] |
| 12 | customer [first_name] and customer[last_name] | customerUsername |
| 13 | customer[email] | customerEmail |
| 14 | amount_paid | amountPaid |
| 15 | tax | taxAmount |
| 16 | note | internalNotes |
| 17 | order_line_items[id] | OrderItem[lineItemKey] |
| 18 | order_line_items[description] | OrderItem[name] |
| 19 | order_line_items[entity_id] | OrderItem[productId] |
| 20 | You can optionally have custom fields plan price[cf_inv_sku] or addon price[cf_inv_sku] or charge price[cf_inv_sku]. These fields are mapped to ShipStation depending on whether order_line_items[entityType] is plan or addon or charge respectively. Within the Custom fields, Field Label and API Name must be [cf_inv_sku]. Otherwise, order_line_items[sku] is mapped to ShipStation. | OrderItem[sku] |
| 21 | order_line_items[fulfillment_quantity] | OrderItem[quantity] |
| 22 | order_line_items[unit_price] | OrderItem[unitPrice] |
| 23 | order_line_items[tax_amount] | OrderItem[taxAmount] |
| 24 | billing_address[first_name] & billing_address[last_name] | billTo[name] |
| 25 | billing_address[company] | billTo[company] |
| 26 | billing_address[line1] | billTo[street1] |
| 27 | billing_address[line2] | billTo[street2] |
| 28 | billing_address[line3] | billTo[street3] |
| 29 | billing_address[city] | billTo[city] |
| 30 | billing_address[state] | billTo[state] |
| 31 | billing_address[zip] | billTo[postalCode] |
| 32 | billing_address[country] | billTo[country] |
| 33 | billing_address[phone] | billTo[phone] |
| 34 | shipping_address | shipTo (field mapping is same as billing_address to billTo mapping) |
Was this article helpful?