Objects

Details of All Available Objects

Definition


Canonical Type Order Objects Name Customer Order
Description ShippingBo Order Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
CreatedAt createdAt  DATETIME CreatedAt
UpdatedAt updatedAt  DATETIME UpdatedAt
Source source  VARCHAR Source
Source_ref source_ref  VARCHAR Source_ref
Origin origin  VARCHAR Origin
Origin_ref origin_ref  VARCHAR Origin_ref
Origin_created_at origin_created_at  DATETIME Origin_created_at
State state  VARCHAR State
Title title@items  >   VARCHAR Title
Product_ref product_ref@items  >   VARCHAR Product_ref
Product_ean product_ean@items  >   VARCHAR Product_ean
Quantity quantity@items  >   INT Quantity
CreatedAt createdAt@items  >   DATETIME CreatedAt
UpdatedAt updatedAt@items  >   DATETIME UpdatedAt
Source source@items  >   VARCHAR Source
Source_ref source_ref@items  >   VARCHAR Source_ref
Discount discount@items  >   DOUBLE Discount
Price price@items  >   PRICE Price
ShippedAt shippedAt  DATETIME ShippedAt
ClosedAt closedAt  DATETIME ClosedAt
StateChangedAt stateChangedAt  DATETIME StateChangedAt
LatestShippedAt latestShippedAt  DATETIME LatestShippedAt
EarliestShippedAt earliestShippedAt  DATETIME EarliestShippedAt
LatestDeliveryAt latestDeliveryAt  DATETIME LatestDeliveryAt
EarliestDeliveryAt earliestDeliveryAt  DATETIME EarliestDeliveryAt
Shipping_address_id shipping_address_id  Address Shipping_address_id
Billing_address_id billing_address_id  Address Billing_address_id
RelayRef relayRef  VARCHAR RelayRef
Fullname shippingAddress__fullname  VARCHAR Fullname
Firstname shippingAddress__firstname  VARCHAR Firstname
Lastname shippingAddress__lastname  VARCHAR Lastname
Company shippingAddress__company  VARCHAR Company
Email shippingAddress__email  EMAIL Email
Phone1 shippingAddress__phone1  PHONE Phone1
Phone2 shippingAddress__phone2  PHONE Phone2
Street1 shippingAddress__street1  VARCHAR Street1
Street2 shippingAddress__street2  VARCHAR Street2
Street3 shippingAddress__street3  VARCHAR Street3
Street4 shippingAddress__street4  VARCHAR Street4
City shippingAddress__city  VARCHAR City
Zip shippingAddress__zip  VARCHAR Zip
State shippingAddress__state  VARCHAR State
Country shippingAddress__country  ISO COUNTRY Country
Building shippingAddress__building  VARCHAR Building
Apartment shippingAddress__apartment  VARCHAR Apartment
Instructions shippingAddress__instructions  VARCHAR Instructions
UpdatedAt shippingAddress__updatedAt  DATETIME UpdatedAt
Fullname billingAddress__fullname  VARCHAR Fullname
Firstname billingAddress__firstname  VARCHAR Firstname
Lastname billingAddress__lastname  VARCHAR Lastname
Company billingAddress__company  VARCHAR Company
Email billingAddress__email  EMAIL Email
Phone1 billingAddress__phone1  PHONE Phone1
Phone2 billingAddress__phone2  PHONE Phone2
Street1 billingAddress__street1  VARCHAR Street1
Street2 billingAddress__street2  VARCHAR Street2
Street3 billingAddress__street3  VARCHAR Street3
Street4 billingAddress__street4  VARCHAR Street4
City billingAddress__city  VARCHAR City
Zip billingAddress__zip  VARCHAR Zip
State billingAddress__state  VARCHAR State
Country billingAddress__country  ISO COUNTRY Country
Building billingAddress__building  VARCHAR Building
Apartment billingAddress__apartment  VARCHAR Apartment
Instructions billingAddress__instructions  VARCHAR Instructions
UpdatedAt billingAddress__updatedAt  DATETIME UpdatedAt
Chosen_delivery_service chosen_delivery_service  VARCHAR Chosen_delivery_service
CarrierId carrierId@shipments  >   VARCHAR CarrierId
CarrierName carrierName@shipments  >   VARCHAR CarrierName
ShippingMethodId shippingMethodId@shipments  >   VARCHAR ShippingMethodId
ShippingMethodName shippingMethodName@shipments  >   VARCHAR ShippingMethodName
ShippingRef shippingRef@shipments  >   VARCHAR ShippingRef
TrackingUrl trackingUrl@shipments  >   URL TrackingUrl
TotalWeight totalWeight  DOUBLE TotalWeight
TotalPrice totalPrice  PRICE TotalPrice
TotalShippingPrice totalShippingPrice  PRICE TotalShippingPrice
TotalDiscountPrice totalDiscountPrice  PRICE TotalDiscountPrice
Order status splashStatut  VARCHAR Status of the order
Is Valid isValidated  BOOL Is Valid
Is Canceled isCanceled  BOOL Is Canceled
Carrier name carrierName  VARCHAR Carrier name
Tracking Number shippingRef  VARCHAR Tracking Number
Tracking Url trackingUrl  URL Tracking Url

Definition


Canonical Type Product Objects Name Product
Description ShippingBo Product Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
User_ref user_ref  VARCHAR User_ref
Ean13 ean13  INT Ean13
Title title  VARCHAR Title
Location location  VARCHAR Location
HsCode hsCode  VARCHAR HsCode
Supplier supplier  VARCHAR Supplier
CreatedAt createdAt  DATETIME CreatedAt
UpdatedAt updatedAt  DATETIME UpdatedAt
Source source  VARCHAR Source
Source_ref source_ref  VARCHAR Source_ref
OtherRef1 otherRef1  VARCHAR OtherRef1
OtherRef2 otherRef2  VARCHAR OtherRef2
OtherRef3 otherRef3  VARCHAR OtherRef3
OtherRef4 otherRef4  VARCHAR OtherRef4
OtherRef5 otherRef5  VARCHAR OtherRef5
OtherRef6 otherRef6  VARCHAR OtherRef6
OtherRef7 otherRef7  VARCHAR OtherRef7
OtherRef8 otherRef8  VARCHAR OtherRef8
OtherRef9 otherRef9  VARCHAR OtherRef9
OtherRef10 otherRef10  VARCHAR OtherRef10
OtherRef11 otherRef11  VARCHAR OtherRef11
OtherRef12 otherRef12  VARCHAR OtherRef12
OtherRef13 otherRef13  VARCHAR OtherRef13
OtherRef14 otherRef14  VARCHAR OtherRef14
OtherRef15 otherRef15  VARCHAR OtherRef15
Weight weight  DOUBLE Weight
Height height  DOUBLE Height
Length length  DOUBLE Length
Width width  DOUBLE Width
PictureUrl pictureUrl  URL PictureUrl
Picture picture  IMG Picture
[Technical] Active enabled  BOOL [Technical] Active
Available Stock stock_available  INT Available Stock

Definition


Canonical Type Address Objects Name Customer Address
Description ShippingBo Address Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Fullname fullname  VARCHAR Fullname
Firstname firstname  VARCHAR Firstname
Lastname lastname  VARCHAR Lastname
Company company  VARCHAR Company
Email email  EMAIL Email
Phone1 phone1  PHONE Phone1
Phone2 phone2  PHONE Phone2
Street1 street1  VARCHAR Street1
Street2 street2  VARCHAR Street2
Street3 street3  VARCHAR Street3
Street4 street4  VARCHAR Street4
City city  VARCHAR City
Zip zip  VARCHAR Zip
State state  VARCHAR State
Country country  ISO COUNTRY Country
Building building  VARCHAR Building
Apartment apartment  VARCHAR Apartment
Instructions instructions  VARCHAR Instructions
CreatedAt createdAt  DATETIME CreatedAt
UpdatedAt updatedAt  DATETIME UpdatedAt