fulfillment
/fulfillment
The fulfillment REST API provides all the functionality necessary to integrate your third party logistics system with UltraCart. This is a replacement for the legacy Distribution Center Transport SOAP API.
/fulfillment
The fulfillment REST API provides all the functionality necessary to integrate your third party logistics system with UltraCart. This is a replacement for the legacy Distribution Center Transport SOAP API.
<?php
/**
* Created by PhpStorm.
* User: perry
* Date: 7/6/2017
* Time: 7:39 AM
*/
// development environment is slower. you probably don't want this stuff.
set_time_limit(3000);
ini_set('max_execution_time', 3000);
ini_set('display_errors', 1);
?>
<!DOCTYPE html>
<html>
<body>
<?php
error_reporting(E_ALL);
require_once(__DIR__ . '/SwaggerClient-php/autoload.php');
$simple_key = 'fb023f40da4a7d015d17b2323f030a0669dd3e4186cd2e015d17b2323f030a06';
ultracart\v2\Configuration::getDefaultConfiguration()->setApiKey('x-ultracart-simple-key', $simple_key);
ultracart\v2\Configuration::getDefaultConfiguration()->addDefaultHeader("X-UltraCart-Api-Version", "2017-03-01");
$distribution_center_code = 'DFLT';
$fulfillment_api = new ultracart\v2\api\FulfillmentApi();
// STEP 1: GET ORDERS NEEDING SHIPPING
// Best practice: Use a webhook instead of polling getOrders here. That will provide instant response.
// This call does take an $expand parameter like many other getXXX calls. The orders are returned with maximum
// expansion by default. So all that's needed is the dc code.
$unacknowledged_orders_response = $fulfillment_api->getDistributionCenterOrders($distribution_center_code);
$unacknowledged_orders = $unacknowledged_orders_response->getOrders();
// STEP 2: ACKNOWLEDGE YOU HAVE RECEIVED ORDERS
// store the unacknowledged orders off somewhere for processing. (not shown here)
// then, acknowledge that you've received them.
// if you have more than 100 orders to acknowledge, send them in batches. limit is 100.
$acknowledged_order_ids = [];
foreach($unacknowledged_orders as $order){
echo $order->getOrderId() . "<br>";
array_push($acknowledged_order_ids, $order->getOrderId());
}
try{
$fulfillment_api->acknowledgeOrders($distribution_center_code, $acknowledged_order_ids);
} catch(\ultracart\v2\ApiException $e){
// acknowledgement failed. examine the reason.
// $e->getResponseBody() has the good information
}
// STEP 3: SHIP ORDERS
// Grab the first order.
$first_order = $unacknowledged_orders[0]; // this will obviously fail if there are none...
// create one or more shipment objects
$fulfillment_shipment = new \ultracart\v2\models\FulfillmentShipment();
$fulfillment_shipment->setOrderId($first_order->getOrderId());
$fulfillment_shipment->setTrackingNumbers(['TrackingNo12345', 'TrackingNo67890']);
$shipments = [$fulfillment_shipment]; // just a single shipment this time
try{
$fulfillment_api->shipOrders($distribution_center_code, $shipments);
} catch(\ultracart\v2\ApiException $e){
// shipment notification failed. examine the reason.
// $e->getResponseBody() has the good information
}
// STEP 4: UPDATE INVENTORIES AS NEEDED
// update inventories as needed.
$first_inventory = new \ultracart\v2\models\FulfillmentInventory();
$first_inventory->setItemId('BONE');
$first_inventory->setQuantity(2500);
$second_inventory = new \ultracart\v2\models\FulfillmentInventory();
$second_inventory->setItemId('BONE');
$second_inventory->setQuantity(2500);
$inventory_updates = [$first_inventory, $second_inventory];
try{
// limit is 500 inventory updates at a time. batch them if you're going large.
$fulfillment_api->updateInventory($distribution_center_code, $inventory_updates);
} catch(\ultracart\v2\ApiException $e){
// update inventory failed. examine the reason.
// $e->getResponseBody() has the good information
}
?>
<!-- helpful diagnostics -->
<pre>
<?php echo print_r($unacknowledged_orders_response); ?>
<?php echo print_r($unacknowledged_orders); ?>
</pre>
<?php echo 'Finished.'; ?>
</body>
</html>
To make working with our API easier, we package an SDK in the languages listed to the right. Select the language that you are interested in and sample code with additional commentary will be available. All of our APIs are available on GitHub at:
http://www.github.com/UltraCart/
By using an SDK you receive a number of important benefits.
There are four steps to instantiating the API.
Full lifecycle example
https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/370868244/Python+SDK+Sample+Fulfillment
# No code here.
# Please see the example above
Acknowledge receipt of orders so that they are removed from the fulfillment queue. This method must be called after receiving and order (via webhook) or retrieving (via retrieve orders method).
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| distribution_center_code | Distribution center code | path | string | required |
| orderIds | Orders to acknowledge receipt of (limit 100) | body | array of string | required |
Full lifecycle example
https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/370868244/Python+SDK+Sample+Fulfillment
# No code here.
# Please see the example above
Update the inventory for items associated with this distribution center
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| distribution_center_code | Distribution center code | path | string | required |
| inventories | Inventory updates (limit 500) | body | array of FulfillmentInventory | required |
Full lifecycle example
https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/370868244/Python+SDK+Sample+Fulfillment
# No code here.
# Please see the example above
Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| distribution_center_code | Distribution center code | path | string | required |
Full lifecycle example
https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/370868244/Python+SDK+Sample+Fulfillment
# No code here.
# Please see the example above
Store the tracking information and mark the order shipped for this distribution center.
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| distribution_center_code | Distribution center code | path | string | required |
| shipments | Orders to mark shipped | body | array of FulfillmentShipment | required |
Full lifecycle example
https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/370868244/Python+SDK+Sample+Fulfillment
# No code here.
# Please see the example above
The following webhook events are generated for this resource.
| Event | Description | Response | Expansion |
|---|---|---|---|
| fulfillment_transmit | Fired when an order is transmitted to the fulfillment company via the webhook. | Order | |
| fulfillment_hold | Trigger when an order is held for review | Order |
| Name | Data Type | Description |
|---|---|---|
| action | string | |
| metric | string | |
| subject | string | |
| ts | integer (int64) | |
| type | string | |
| uuid | string |
| Name | Data Type | Description |
|---|---|---|
| currency_code | string | Currency code of the localized value |
| exchange_rate | number | Exchange rate used to localize |
| localized | number | Value localized to the customer |
| localized_formatted | string | Value localized and formatted for the customer |
| value | number | Value in base currency |
| Name | Data Type | Description |
|---|---|---|
| activity | CustomerActivity | activity by this customer |
| affiliate_oid | integer (int32) | Affiliate oid |
| allow_3rd_party_billing | boolean | Allow 3rd party billing |
| allow_cod | boolean | Allow COD |
| allow_purchase_order | boolean | Allow purchase orders by this customer |
| allow_quote_request | boolean | Allow quote request |
| allow_selection_of_address_type | boolean | Allow selection of residential or business address type |
| attachments | array of CustomerAttachment | Attachments |
| auto_approve_cod | boolean | Auto approve COD |
| auto_approve_purchase_order | boolean | Auto approve purchase orders by this customer |
| automatic_merchant_notes | string | Automatic merchant notes are added to every order placed |
| billing | array of CustomerBilling | Billing addresses for this customer |
| business_notes | string(2000) | Business notes (internally visible only) |
| cards | array of CustomerCard | Credit Cards for this customer |
| cc_emails | array of CustomerEmail | Additional emails to CC notification |
| customer_profile_oid | (read only) integer (int32) | Customer profile object identifier |
| dhl_account_number | string(20) | DHL account number |
| dhl_duty_account_number | string(20) | DHL duty account number |
| string | Email address of this customer profile | |
| exempt_shipping_handling_charge | boolean | Exempt shipping handling charge |
| fedex_account_number | string(20) | FedEx account number |
| free_shipping | boolean | This customer always receives free shipping |
| free_shipping_minimum | number | If free_shipping is true, this is the minimum subtotal required for free shipping |
| last_modified_by | (read only) string(100) | Last modified by |
| last_modified_dts | (read only) string (dateTime) | Last modified date |
| loyalty | CustomerLoyalty | Loyalty |
| maximum_item_count | integer (int32) | Maximum item count |
| minimum_item_count | integer (int32) | Minimum item count |
| minimum_subtotal | number | Minimum subtotal |
| no_coupons | boolean | No coupons |
| no_free_shipping | boolean | No free shipping regardless of coupons or item level settings |
| no_realtime_charge | boolean | No realtime charge |
| orders | array of Order | Orders associated with this customer profile |
| orders_summary | CustomerOrdersSummary | Summary of orders placed by this customer profile |
| password | string(30) | Password (may only be set, never read) |
| pricing_tiers | array of CustomerPricingTier | Pricing tiers for this customer |
| privacy | CustomerPrivacy | Privacy settings of the customer profile |
| qb_class | string | QuickBooks class to import this customer as |
| qb_code | string | QuickBooks name to import this customer as |
| quotes | array of Order | Quotes associated with this customer profile |
| quotes_summary | CustomerQuotesSummary | Summary of the quotes submitted by this customer profile |
| referral_source | string(50) | Referral Source |
| reviewer | CustomerReviewer | Item reviewer information |
| sales_rep_code | string(10) | Sales rep code |
| send_signup_notification | boolean | Send signup notification, if true during customer creation, will send a notification. |
| shipping | array of CustomerShipping | Shipping addresses for this customer |
| signup_dts | (read only) string | Signup date |
| software_entitlements | array of CustomerSoftwareEntitlement | Software entitlements owned by this customer |
| suppress_buysafe | boolean | Suppress buySAFE |
| tags | array of CustomerTag | Tags for this customer |
| tax_codes | CustomerTaxCodes | Tax codes used by tax integrations |
| tax_exempt | boolean | True if the customer is tax exempt |
| tax_id | string(15) | Tax ID |
| terms | string | Terms for this customer |
| track_separately | boolean | True if the customer should be tracked separately in QuickBooks |
| unapproved | boolean | Unapproved |
| ups_account_number | string(20) | UPS account number |
| website_url | string(100) | Website url |
| Name | Data Type | Description |
|---|---|---|
| activities | array of Activity | |
| memberships | array of ListSegmentMembership | |
| metrics | array of Metric | |
| properties_list | array of Property |
| Name | Data Type | Description |
|---|---|---|
| customer_profile_attachment_oid | (read only) integer (int32) | Attachment identifier |
| description | string | Description |
| file_name | (read only) string | File name |
| mime_type | (read only) string | Mime typoe |
| upload_dts | (read only) string (dateTime) | Upload date/time |
| Name | Data Type | Description |
|---|---|---|
| address1 | string(50) | Address line 1 |
| address2 | string(50) | Address line 2 |
| city | string(32) | City |
| company | string(50) | Company |
| country_code | string(2) | ISO-3166 two letter country code |
| customer_billing_oid | (read only) integer (int32) | Customer profile billing object identifier |
| customer_profile_oid | (read only) integer (int32) | Customer profile object identifier |
| day_phone | string(25) | Day phone |
| default_billing | boolean | Default billing |
| evening_phone | string(25) | Evening phone |
| first_name | string(30) | First name |
| last_name | string(30) | Last name |
| last_used_dts | string (dateTime) | Last used date |
| postal_code | string(20) | Postal code |
| state_region | string(32) | State for United States otherwise region or province for other countries |
| tax_county | string(32) | Tax County |
| title | string(50) | Title |
| Name | Data Type | Description |
|---|---|---|
| card_expiration_month | integer (int32) | Card expiration month (1-12) |
| card_expiration_year | integer (int32) | Card expiration year (four digit year) |
| card_number | string | Card number (masked to the last 4) |
| card_number_token | string | Hosted field token for the card number |
| card_type | string | Card type |
| customer_profile_credit_card_id | integer (int32) | ID of the stored credit card to use |
| customer_profile_oid | (read only) integer (int32) | Customer profile object identifier |
| last_used_dts | string (dateTime) | Last used date |
| Name | Data Type | Description |
|---|---|---|
| customer_profile_email_oid | integer (int32) | ID of the email |
| string(100) | ||
| label | string(100) | Label |
| receipt_notification | boolean | CC this email on receipt notifications |
| refund_notification | boolean | CC this email on refund notifications |
| shipment_notification | boolean | CC this email on shipment notifications |
| Name | Data Type | Description |
|---|---|---|
| current_points | (read only) integer (int32) | Current Points |
| ledger_entries | (read only) array of CustomerLoyaltyLedger | Ledger entries |
| redemptions | (read only) array of CustomerLoyaltyRedemption | Redemptions |
| Name | Data Type | Description |
|---|---|---|
| created_by | (read only) string | Created By |
| created_dts | (read only) string (dateTime) | Created date |
| description | (read only) string | Description |
| (read only) string | ||
| item_id | (read only) string | Item Id |
| item_index | (read only) integer (int32) | Item Index |
| ledger_dts | (read only) string (dateTime) | Ledger date |
| loyalty_campaign_oid | (read only) integer (int32) | Loyalty campaign oid |
| loyalty_ledger_oid | (read only) integer (int32) | Loyalty ledger oid |
| loyalty_points | (read only) integer (int32) | Loyalty points |
| modified_by | (read only) string | Modified By |
| modified_dts | (read only) string (dateTime) | Modified date |
| order_id | (read only) string | Order Id |
| quantity | (read only) integer (int32) | Quantity |
| vesting_dts | (read only) string (dateTime) | Vesting date |
| Name | Data Type | Description |
|---|---|---|
| coupon_code | (read only) string | Coupon code |
| coupon_code_oid | (read only) integer (int32) | Coupon code OID |
| coupon_used | (read only) boolean | Coupon used |
| description_for_customer | (read only) string | Description for customer |
| expiration_dts | (read only) string (dateTime) | Expiration date |
| gift_certificate_code | (read only) string | Gift certificate code |
| gift_certificate_oid | (read only) integer (int32) | Gift certificate oid |
| loyalty_ledger_oid | (read only) integer (int32) | Loyalty ledger OID |
| loyalty_points | (read only) integer (int32) | Loyalty points |
| loyalty_redemption_oid | (read only) integer (int32) | Loyalty redemption OID |
| order_id | (read only) string | Order id |
| redemption_dts | (read only) string (dateTime) | Redemption date |
| remaining_balance | (read only) number | Remaining balance |
| Name | Data Type | Description |
|---|---|---|
| first_order_dts | (read only) string (dateTime) | First order date |
| last_order_dts | (read only) string (dateTime) | Last order date |
| order_count | integer (int32) | Total number of orders |
| total | number | Total amount associated with the orders |
| Name | Data Type | Description |
|---|---|---|
| name | string(50) | Name |
| pricing_tier_oid | integer (int32) | Pricing Tier Oid |
| Name | Data Type | Description |
|---|---|---|
| last_update_dts | (read only) string (dateTime) | Last update date |
| marketing | (read only) boolean | The customer has opted in to marketing |
| preference | (read only) boolean | The customer has opted in to preference tracking |
| statistics | (read only) boolean | The customer has opted in to statistics collection |
| Name | Data Type | Description |
|---|---|---|
| first_quote_dts | (read only) string (dateTime) | First quote date |
| last_quote_dts | (read only) string (dateTime) | Last quote date |
| quote_count | integer (int32) | Total number of quote |
| total | number | Total amount associated with the quotes |
| Name | Data Type | Description |
|---|---|---|
| auto_approve | boolean | True if reviewes from this customer profile should automatically be approved |
| average_overall_rating | (read only) number | Average overall rating of items reviewed |
| expert | boolean | True if the customer is an expert |
| first_review | (read only) string (dateTime) | First review |
| last_review | (read only) string (dateTime) | Last review |
| location | string | Location of the reviewer |
| nickname | string | Nickname of the reviewer |
| number_helpful_review_votes | (read only) integer (int32) | Number of helpful review votes |
| rank | (read only) integer (int32) | Rank of this reviewer |
| reviews_contributed | (read only) integer (int32) | Number of reviews contributed |
| Name | Data Type | Description |
|---|---|---|
| address1 | string(50) | Address line 1 |
| address2 | string(50) | Address line 2 |
| city | string(32) | City |
| company | string(50) | Company |
| country_code | string(2) | ISO-3166 two letter country code |
| customer_profile_oid | (read only) integer (int32) | Customer profile object identifier |
| customer_shipping_oid | (read only) integer (int32) | Customer profile shipping object identifier |
| day_phone | string(25) | Day phone |
| default_shipping | boolean | Default shipping |
| evening_phone | string(25) | Evening phone |
| first_name | string(30) | First name |
| last_name | string(30) | Last name |
| last_used_dts | string (dateTime) | Last used date |
| postal_code | string(20) | Postal code |
| state_region | string(32) | State for United States otherwise region or province for other countries |
| tax_county | string(32) | Tax County |
| title | string(50) | Title |
| Name | Data Type | Description |
|---|---|---|
| activation_code | string(50) | Activation Code Associated with the software |
| activation_dts | string (dateTime) | Date/time when the activation code was created |
| customer_software_entitlement_oid | (read only) integer (int32) | Customer profile software entitlement object identifier |
| expiration_dts | string (dateTime) | Date/time when the activation code will expire |
| purchased_via_item_description | (read only) string(512) | Item description used to purchase this software. |
| purchased_via_item_id | (read only) string(20) | Item ID used to purchase this software. |
| purchased_via_order_id | (read only) string(30) | Order ID used to purchase this software. |
| software_sku | string(30) | SKU of the software |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(100) | Tag Value |
| Name | Data Type | Description |
|---|---|---|
| avalara_customer_code | string | Avalara customer code |
| avalara_entity_use_code | string | Avalara entity use code |
| taxjar_customer_id | string | TaxJar customer id |
| Name | Data Type | Description |
|---|---|---|
| uom | string | Unit of measure
Allowed Values
|
| value | number | The distance measured in UOM |
| Name | Data Type | Description |
|---|---|---|
| address1 | string | Address line 1 of the distribution center |
| address2 | string | Address line 2 of the distribution center |
| city | string | City of the distribution center |
| code | string | Unique code for this distribution center |
| country_code | string | Country code of the distribution center |
| default_center | boolean | True if this is the default distribution center on the account |
| default_handles_all_items | boolean | True if this distribution center handles all new items by default |
| distribution_center_oid | (read only) integer (int32) | Distribution center object identifier |
| duns | string | DUNS number assigned to this distribution center (EDI) |
| estimate_from_distribution_center_oid | integer (int32) | Estimate shipments for this distribution center as if they came from the other distribution center |
| ftp_password | string | Password associated with the virtual FTP |
| hold_before_shipment_minutes | integer (int32) | The number of minutes to hold a shipment |
| hold_before_transmission | boolean | True if the shipment should be held before transmission and require a manual release |
| holdAutoOrderBeforeShipmentMinutes | integer (int32) | |
| latitude | number | Latitude where the distribution center is located |
| longitude | number | Longitude where the distribution center is located |
| name | string | Name of this distribution center |
| no_customer_direct_shipments | boolean | True if this distribution center does not handle customer direct shipments |
| no_split_shipment | boolean | True if this distribution center is not allowed to participate in a split shipment. |
| postal_code | string | Postal code of the distribution center |
| process_days | integer (int32) | The number of processing days required before an order ships |
| process_inventory_start_time | string | The time (EST) after which inventory updates will be processed |
| process_inventory_stop_time | string | The time (EST) before which inventory updates will be processed |
| require_asn | boolean | True if ASNs are required for this distribution center (EDI) |
| send_kit_instead_of_components | boolean | True if we should send the kit instead of the components |
| shipment_cutoff_time_friday | string | The time (EST) after which shipments will not be processed on Friday |
| shipment_cutoff_time_monday | string | The time (EST) after which shipments will not be processed on Monday |
| shipment_cutoff_time_saturday | string | The time (EST) after which shipments will not be processed on Saturday |
| shipment_cutoff_time_sunday | string | The time (EST) after which shipments will not be processed on Sunday |
| shipment_cutoff_time_thursday | string | The time (EST) after which shipments will not be processed on Thursday |
| shipment_cutoff_time_tuesday | string | The time (EST) after which shipments will not be processed on Tuesday |
| shipment_cutoff_time_wednesday | string | The time (EST) after which shipments will not be processed on Wednesday |
| state | string | State of the distribution center |
| transport | string | Transport mechanism for this distribution center |
| Name | Data Type | Description |
|---|---|---|
| distribution_centers | array of DistributionCenter | |
| error | Error | Error object if unsuccessful |
| metadata | ResponseMetadata | Meta-data about the response such as payload or paging information |
| success | boolean | Indicates if API call was successful |
| Name | Data Type | Description |
|---|---|---|
| developer_message | string | A technical message meant to be read by a developer |
| error_code | string | HTTP status code |
| more_info | string | Additional information often a link to additional documentation |
| user_message | string | An end-user friendly message suitable for display to the customer |
| Name | Data Type | Description |
|---|---|---|
| error | Error | Error object if unsuccessful |
| metadata | ResponseMetadata | Meta-data about the response such as payload or paging information |
| success | boolean | Indicates if API call was successful |
| Name | Data Type | Description |
|---|---|---|
| itemId | string | |
| quantity | number |
| Name | Data Type | Description |
|---|---|---|
| fulfillment_fee | number | Fees charged by the fulfillment company other than the shipping cost to process the order. |
| order_id | string | Order ID that was shipped |
| package_cost | number | The cost of the packaging used to sent this shipment |
| shipping_cost | number | The actual total cost of shipping this order |
| tracking_numbers | array of string | Tracking numbers associated with the shipment |
| Name | Data Type | Description |
|---|---|---|
| name | string | |
| type | string | |
| uuid | string |
| Name | Data Type | Description |
|---|---|---|
| all_time | number | |
| all_time_formatted | string | |
| last_30 | number | |
| last_30_formatted | string | |
| name | string | |
| prior_30 | number | |
| prior_30_formatted | string | |
| type | string |
| Name | Data Type | Description |
|---|---|---|
| affiliates | (read only) array of OrderAffiliate | Affiliates if any were associated with the order. The first one in the array sent the order and each subsequent affiliate is the recruiter that earns a downline commission. |
| auto_order | (read only) OrderAutoOrder | Auto Order |
| billing | OrderBilling | Billing |
| buysafe | OrderBuysafe | buySAFE bond |
| channel_partner | (read only) OrderChannelPartner | Channel Partner if one is associated with the order |
| checkout | OrderCheckout | Checkout |
| coupons | array of OrderCoupon | Coupons |
| creation_dts | (read only) string (dateTime) | Date/time that the order was created |
| currency_code | string(3) | Currency code that the customer used if different than the merchant's base currency code
Allowed Values
|
| current_stage | string | Current stage that the order is in.
Allowed Values
|
| customer_profile | (read only) Customer | Customer profile if one is associated with the order |
| digital_order | OrderDigitalOrder | Digital order details |
| edi | OrderEdi | EDI related information (only for orders received via EDI channel partner) |
| exchange_rate | number | Exchange rate at the time the order was placed if currency code is different than the base currency |
| fraud_score | (read only) OrderFraudScore | Fraud score if checked on the order |
| gift | OrderGift | Gift giving information |
| gift_certificate | (read only) OrderGiftCertificate | Gift certificate used on the order |
| internal | OrderInternal | Internal |
| items | array of OrderItem | Items |
| language_iso_code | (read only) string(3) | Three letter ISO-639 language code used by the customer during the checkout if different than the default language |
| linked_shipment | (read only) OrderLinkedShipment | Linked shipment information (CCBill orders only) |
| marketing | OrderMarketing | Marketing |
| merchant_id | (read only) string | UltraCart merchant ID owning this order |
| order_id | (read only) string | Order ID |
| payment | OrderPayment | Payment |
| properties | array of OrderProperty | Properties, available only through update, not through insert due to the nature of how properties are handled internally |
| quote | (read only) OrderQuote | Quote |
| refund_dts | (read only) string (dateTime) | If the order was refunded, the date/time that the last refund occurred |
| reject_dts | (read only) string (dateTime) | If the order was rejected, the date/time that the rejection occurred |
| salesforce | (read only) OrderSalesforce | Salesforce.com identifiers |
| shipping | OrderShipping | Shipping |
| summary | OrderSummary | Summary |
| Tags | array of OrderTag | tags, available only through update, not through insert due to the nature of how tags are handled internally |
| taxes | OrderTaxes | Taxes |
| Name | Data Type | Description |
|---|---|---|
| affiliate_oid | integer (int32) | Affiliate ID |
| ledger_entries | array of OrderAffiliateLedger | Ledger entries associated with all the commissions earned on this order |
| sub_id | string | Sub identifier provided by the affiliate on the click that generated this order |
| Name | Data Type | Description |
|---|---|---|
| assigned_by_user | string | UltraCart user name that assigned this commission if manually assigned |
| item_id | string | Item ID that this ledger record is associated with |
| tier_number | integer (int32) | Tier number of this affiliate in the commission calculation |
| transaction_amount | number | Amount of the transaction |
| transaction_amount_paid | number | The amount that has been paid so far on the transaction |
| transaction_dts | string (dateTime) | The date/time that the affiliate ledger was generated for the transaction |
| transaction_memo | string | Details of the transaction suitable for display to the affiliate |
| transaction_percentage | number | The percentage earned on the transaction |
| transaction_state | string | The state of the transaction
Allowed Values
|
| Name | Data Type | Description |
|---|---|---|
| auto_order_code | string | Unique code assigned to the auto order |
| auto_order_oid | integer (int32) | Unique identifier assigned to the auto order |
| original_order_id | string | Orignal order id that started this auto order sequence |
| status | string | The status of the auto order
Allowed Values
|
| Name | Data Type | Description |
|---|---|---|
| address1 | string(50) | Address line 1 |
| address2 | string(50) | Address line 2 |
| cc_emails | array of string | CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters. |
| city | string(32) | City |
| company | string(50) | Company |
| country_code | string(2) | ISO-3166 two letter country code |
| day_phone | string(25) | Day time phone |
| day_phone_e164 | (read only) string(25) | Day time phone (E164 format) |
| string(100) | ||
| evening_phone | string(25) | Evening phone |
| first_name | string(30) | First name |
| last_name | string(30) | Last name |
| postal_code | string(20) | Postal code |
| state_region | string(32) | State for United States otherwise region or province for other countries |
| title | string(50) | Title |
| Name | Data Type | Description |
|---|---|---|
| buysafe_bond_available | (read only) boolean | True if a buySAFE bond was available for purchase on this order |
| buysafe_bond_cost | (read only) Currency | Cost of the buySAFE bond |
| buysafe_bond_free | (read only) boolean | True if the buySAFE bond was free for this order |
| buysafe_bond_refunded | (read only) Currency | Amount of the buySAFE bond that was refunded |
| buysafe_bond_wanted | boolean | True if the buySAFE bond was wanted by the customer |
| buysafe_shopping_cart_id | (read only) string | Shopping cart ID associated with the buySAFE bond |
| Name | Data Type | Description |
|---|---|---|
| auto_approve_purchase_order | boolean | If true, any purchase order submitted is automatically approved |
| channel_partner_code | string | The code of the channel partner |
| channel_partner_data | string | Additional data provided by the channel partner, read-only |
| channel_partner_oid | integer (int32) | Channel partner object identifier, read-only and available on existing channel orders only. |
| channel_partner_order_id | string | The order ID assigned by the channel partner for this order |
| no_realtime_payment_processing | boolean | Indicates this order should be placed in Account Receivable for later payment processing |
| skip_payment_processing | boolean | Indicates this order was already paid for via a channel purchase and no payment collection should be attempted |
| store_completed | boolean | Instructs UltraCart to skip shipping department and mark this order as fully complete. Set this flag if you have already shipped product for this order. |
| store_if_payment_declines | boolean | If true, any failed payment will place the order in Accounts Receivable rather than rejecting it. |
| treat_warnings_as_errors | boolean | Any warnings are raised as errors and halt the import of the order |
| Name | Data Type | Description |
|---|---|---|
| comments | string | Comments from the customer. Rarely used on the single page checkout. |
| custom_field1 | string(50) | Custom field 1 |
| custom_field2 | string(50) | Custom field 2 |
| custom_field3 | string(50) | Custom field 3 |
| custom_field4 | string(50) | Custom field 4 |
| custom_field5 | string(75) | Custom field 5 |
| custom_field6 | string(50) | Custom field 6 |
| custom_field7 | string(50) | Custom field 7 |
| customer_ip_address | (read only) string | IP address of the customer when placing the order |
| screen_branding_theme_code | string(10) | Screen branding theme code associated with the order (legacy checkout) |
| storefront_host_name | string | StoreFront host name associated with the order |
| upsell_path_code | (read only) string | Upsell path code assigned during the checkout that the customer went through |
| Name | Data Type | Description |
|---|---|---|
| accounting_code | (read only) string | QuickBooks accounting code for this coupon |
| automatically_applied | (read only) boolean | Whether or not the coupon was automatically applied to the order |
| base_coupon_code | string(20) | Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon |
| coupon_code | string(20) | Coupon code entered by the customer |
| Name | Data Type | Description |
|---|---|---|
| file_size | (read only) integer (int64) | File size |
| last_download | (read only) string (dateTime) | Last download |
| last_download_ip_address | (read only) string | IP address that performed the last download |
| original_filename | (read only) string | Original file name |
| product_code | (read only) string | Item id associated with this item |
| product_description | (read only) string | Item description associated with this item |
| remaining_downloads | integer (int32) | Remaining number of downloads |
| url | (read only) string | URL that the customer can click to download the specific digital item |
| Name | Data Type | Description |
|---|---|---|
| creation_dts | (read only) string (dateTime) | Date/time that the digital order was created |
| expiration_dts | string (dateTime) | Expiration date/time of the digital order |
| items | array of OrderDigitalItem | Digital items associated with the digital order |
| url | (read only) string | URL where the customer can go to and download their digital order content |
| url_id | (read only) string | URL ID is a unique code that is part of the URLs |
| Name | Data Type | Description |
|---|---|---|
| bill_to_edi_code | string | Billing address identification code from the EDI order. Typically DUNS or DUNS+4 |
| edi_department | string | Department number associated with this EDI order |
| edi_internal_vendor_number | string(50) | Internal vendor number associated with this EDI order |
| ship_to_edi_code | string | Shipping address identification code from the EDI order. Typically DUNS or DUNS+4 |
| Name | Data Type | Description |
|---|---|---|
| anonymous_proxy | boolean | True if the IP address is a known anonymous proxy server |
| bin_match | string | Whether the BIN (first six digits) matched the country
Allowed Values
|
| carder_email | boolean | True if the email address belongs to a known credit card fraudster |
| country_code | string | Country code |
| country_match | boolean | Country code matches BIN country |
| customer_phone_in_billing_location | string | Whether the customer's phone number is located in the area of the billing address |
| distance_km | integer (int32) | Distance in kilometers between the IP address and the BIN |
| free_email | boolean | True if the email address is for a free service like gmail.com |
| high_risk_country | boolean | True if the customer is in a high risk country known for internet fraud |
| ip_city | string | City associated with the IP address |
| ip_isp | string | ISP that owns the IP address |
| ip_latitude | string | Approximate latitude associated with the IP address |
| ip_longitude | string | Approximate longitude associated with the IP address |
| ip_org | string | Organization that owns the IP address |
| ip_region | string | State/region associated with the IP address |
| proxy_score | number | Likelihood of the IP address being a proxy server |
| score | number | Overall score. This is the score that is compared to see if the order is rejected or held for review by the fraud filter rules. |
| ship_forwarder | boolean | True if the address is a known ship forwarding company |
| spam_score | number | Likelihood of the email address being associated with a spammer |
| transparent_proxy | boolean | True if the IP address that placed the order is a transparent proxy server |
| Name | Data Type | Description |
|---|---|---|
| gift | boolean | True if the order is a gift |
| gift_charge | Currency | Charge associated with making this order a gift |
| gift_charge_accounting_code | (read only) string | QuickBooks code for the gift charge |
| gift_charge_refunded | Currency | Amount refunded of the gift charge (read only except refund operation) |
| gift_email | string(100) | Email address of the gift recipient |
| gift_message | string(10000) | Message to the gift recipient |
| gift_wrap_accounting_code | (read only) string | QuickBooks code for the gift wrap charge |
| gift_wrap_cost | Currency | Cost of the gift wrap the customer selected |
| gift_wrap_refunded | Currency | Amount refunded of the gift wrap (read only except refund operation) |
| gift_wrap_title | string(30) | Title of the gift wrap that the customer wants used |
| Name | Data Type | Description |
|---|---|---|
| gift_certificate_amount | (read only) Currency | Gift certificate amount applied to the order |
| gift_certificate_code | (read only) string | Gift certificate code used on the order |
| gift_certificate_oid | (read only) integer (int32) | Gift certificate object identifier |
| Name | Data Type | Description |
|---|---|---|
| exported_to_accounting | boolean | True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true |
| merchant_notes | string | Merchant notes |
| placed_by_user | (read only) string | If placed via the BEOE, this is the user that placed the order |
| refund_by_user | (read only) string | User that issued the refund |
| sales_rep_code | string(10) | Sales rep code associated with the order |
| Name | Data Type | Description |
|---|---|---|
| accounting_code | (read only) string | QuickBooks code |
| activation_codes | array of string | Activation codes assigned to this item |
| arbitrary_unit_cost | Currency | Arbitrary unit cost, used only during inserts for overriding the unit cost of an item |
| auto_order_last_rebill_dts | string (dateTime) | Date/time of the last rebill, used only during order insert to help project future rebills |
| auto_order_schedule | string | Auto order schedule, used only during inserts supplying the recurring schedule |
| barcode | (read only) string | Barcode |
| channel_partner_item_id | string(30) | Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id |
| cogs | (read only) number | Cost of goods sold |
| component_unit_value | (read only) number | Value of the kit component item |
| cost | Currency | Cost |
| country_code_of_origin | (read only) string(2) | Country of origin (ISO-3166 two letter code) |
| customs_description | (read only) string | Customs description |
| description | string(2000) | Description |
| discount | (read only) Currency | Discount |
| discount_quantity | (read only) number | Discount quantity |
| discount_shipping_weight | (read only) Weight | Discount shipping weight |
| distribution_center_code | string | Distribution center code responsible for shipping this item |
| edi | OrderItemEdi | EDI related item information |
| exclude_coupon | boolean | True if this item is excluded from coupons |
| free_shipping | boolean | True if the item receives free shipping |
| hazmat | boolean | Hazardous materials indicator |
| height | Distance | Height |
| item_reference_oid | (read only) integer (int32) | Item reference object identifier used to linked to auto order item record |
| kit | boolean | True if this item is a kit |
| kit_component | boolean | True if this item is a kit component |
| length | Distance | Length |
| manufacturer_sku | (read only) string | Manufacturer SKU |
| max_days_time_in_transit | integer (int32) | Maximum days that the item can be in transit before spoilage (perishable products) |
| merchant_item_id | string(20) | Item ID |
| mix_and_match_group_name | string | Mix and match group name |
| mix_and_match_group_oid | integer (int32) | Mix and match group object identifier |
| no_shipping_discount | boolean | True if this item is excluded from shipping discounts |
| options | array of OrderItemOption | Options |
| packed_by_user | (read only) string | Packed by user |
| perishable_class | string(50) | Perishable class of the item |
| pricing_tier_name | string | Pricing tier that granted the particular price for this item if the customer profile had pricing tiers assigned |
| properties | array of OrderItemProperty | Properties |
| quantity | number | Quantity |
| quantity_refunded | number | Quantity refunded on this item (read only except refund operation) |
| quickbooks_class | string(31) | QuickBooks class |
| ship_separately | boolean | True if this item ships in a separate box |
| shipped_by_user | (read only) string | Shipped by user |
| shipped_dts | string (dateTime) | Date/time that this item was marked shipped |
| special_product_type | string | Special product type (USPS Media Mail)
Allowed Values
|
| tags | array of OrderItemTag | Tags |
| tax_free | boolean | True if the item is tax free |
| taxable_cost | Currency | The taxable cost of the item. Typically the same as the cost |
| total_cost_with_discount | (read only) Currency | Total cost with discount |
| total_refunded | Currency | Total refunded on this item (read only except refund operation) |
| transmitted_to_distribution_center_dts | string (dateTime) | Date/time that this item was transmitted to the distribution center |
| unit_cost_with_discount | (read only) Currency | Unit cost with discount |
| upsell | boolean | True if this item was added to the order as part of an upsell |
| weight | Weight | Weight |
| width | Distance | Width |
| Name | Data Type | Description |
|---|---|---|
| identifications | (read only) array of OrderItemEdiIdentification | Identification information receives on the EDI purchase order |
| lots | (read only) array of OrderItemEdiLot | Lot information |
| Name | Data Type | Description |
|---|---|---|
| identification | string | Identification value |
| quantity | integer (int32) | Quantity associated with this identifier |
| Name | Data Type | Description |
|---|---|---|
| lot_expiration | string (dateTime) | Log expiration |
| lot_number | string | Lot number |
| lot_quantity | integer (int32) | Lot quantity |
| Name | Data Type | Description |
|---|---|---|
| additional_dimension_application | string | How the additional dimensions are applied to the item.
Allowed Values
|
| cost_change | Currency | The amount that this option changes the cost |
| file_attachment | (read only) OrderItemOptionFileAttachment | File attachment if option_type is file and attachment has not expired. |
| height | Distance | If additional_dimension_application != none Height |
| hidden | boolean | True if this option is hidden from display on the order |
| label | string(50) | Label |
| length | Distance | If additional_dimension_application != none Length |
| one_time_fee | boolean | True if the cost associated with this option is a one time fee or multiplied by the quantity of the item |
| value | string(1024) | Value |
| weight_change | Weight | The amount that this option changes the weight |
| width | Distance | If additional_dimension_application != none Width |
| Name | Data Type | Description |
|---|---|---|
| expiration_dts | string (dateTime) | Expiration date/time |
| file_name | string | File name |
| mime_type | string | Mime type |
| size | integer (int32) | Size |
| Name | Data Type | Description |
|---|---|---|
| display | boolean | True if this property is displayed to the customer |
| expiration_dts | string (dateTime) | The date/time that the property expires and is deleted |
| name | string(100) | Name |
| value | string(3800) | Value |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(100) | Tag Value |
| Name | Data Type | Description |
|---|---|---|
| has_linked_shipment | boolean | True if this order has child linked shipments |
| linked_shipment | boolean | True if this order is linked to another parent order |
| linked_shipment_channel_partner_order_ids | array of string | If has_linked_shipment=true The child linked shipment channel partner order ids |
| linked_shipment_order_ids | array of string | If has_linked_shipment=true The child linked shipment order ids |
| linked_shipment_to_order_id | string | If linked_shipment=true The parent order id that this one is linked to |
| Name | Data Type | Description |
|---|---|---|
| advertising_source | string(50) | Advertising source |
| mailing_list | boolean | True if the customer has opted into mailing list subscription |
| referral_code | string(30) | Referral code |
| Name | Data Type | Description |
|---|---|---|
| check | OrderPaymentCheck | If payment_method=Check Check payment information |
| credit_card | OrderPaymentCreditCard | If payment_method=Credit Card Credit card payment information |
| echeck | OrderPaymentECheck | If payment_method=eCheck E-Check payment information |
| hold_for_fraud_review | (read only) boolean | True if order has been held for fraud review |
| payment_dts | string (dateTime) | Date/time that the payment was successfully processed, for new orders, this field is only considered if channel_partner.skip_payment_processing is true |
| payment_method | string | Payment method
Allowed Values
|
| payment_method_accounting_code | (read only) string | Payment method QuickBooks code |
| payment_method_deposit_to_account | (read only) string | Payment method QuickBooks deposit account |
| payment_status | (read only) string | Payment status
Allowed Values
|
| purchase_order | OrderPaymentPurchaseOrder | If payment_method=Purchase Order Purchase order information |
| rotating_transaction_gateway_code | (read only) string | Rotating transaction gateway code used to process this order |
| surcharge | (read only) Currency | Surcharge amount calculated from surcahrge_transaction_fee and surcharge_transaction_percentage |
| surcharge_accounting_code | (read only) string | Surcharge accounting code |
| surcharge_transaction_fee | number | Surcharge transaction fee |
| surcharge_transaction_percentage | number | Surcharge transaction percentage |
| test_order | (read only) boolean | True if this is a test order |
| transactions | (read only) array of OrderPaymentTransaction | Transactions associated with processing this payment |
| Name | Data Type | Description |
|---|---|---|
| check_number | string | Check number |
| Name | Data Type | Description |
|---|---|---|
| card_auth_ticket | (read only) string | Card authorization ticket |
| card_authorization_amount | (read only) number | Card authorization amount |
| card_authorization_dts | (read only) string (dateTime) | Card authorization date/time |
| card_authorization_reference_number | (read only) string | Card authorization reference number |
| card_expiration_month | integer (int32) | Card expiration month (1-12) |
| card_expiration_year | integer (int32) | Card expiration year (Four digit year) |
| card_number | (read only) string | Card number (masked to last 4) |
| card_number_token | string | Card number token from hosted fields used to update the cart number |
| card_number_truncated | (read only) boolean | True if the card has been truncated |
| card_type | string | Card type
Allowed Values
|
| card_verification_number_token | string | Card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries |
| Name | Data Type | Description |
|---|---|---|
| bank_aba_code | string(9) | Bank routing code |
| bank_account_name | string(50) | Bank account name |
| bank_account_number | string(50) | Bank account number (masked to last 4) |
| bank_account_type | string | Bank account type
Allowed Values
|
| bank_name | string(50) | Bank name |
| bank_owner_type | string | Bank owner type
Allowed Values
|
| customer_tax_id | string(9) | Customer tax id (masked to last 4) |
| drivers_license_dob | string(10) | Driver license date of birth |
| drivers_license_number | string(50) | Driver license number (masked to last 4) |
| drivers_license_state | string(2) | Driver license state |
| Name | Data Type | Description |
|---|---|---|
| purchase_order_number | string | Purchase order number |
| Name | Data Type | Description |
|---|---|---|
| details | array of OrderPaymentTransactionDetail | Details |
| successful | boolean | True if the transaction was successful |
| transaction_gateway | string | Transaction gateway |
| transaction_timestamp | string (dateTime) | Transaction date/time |
| Name | Data Type | Description |
|---|---|---|
| name | string | Name |
| type | string | Type |
| value | string | Value |
| Name | Data Type | Description |
|---|---|---|
| display | boolean | True if this property is displayed to the customer |
| expiration_dts | string (dateTime) | The date/time that the property expires and is deleted |
| name | string(100) | Name |
| value | string(3800) | Value |
| Name | Data Type | Description |
|---|---|---|
| quote_expiration_dts | string (dateTime) | Expiration of quote at date/time |
| quoted_by | string | Quoted by user |
| quoted_dts | string (dateTime) | Quoted on date/time |
| Name | Data Type | Description |
|---|---|---|
| salesforce_opportunity_id | string | Salesforce.com opportunity id |
| Name | Data Type | Description |
|---|---|---|
| address1 | string(50) | Address line 1 |
| address2 | string(50) | Address line 2 |
| city | string(32) | City |
| company | string(50) | Company |
| country_code | string(2) | ISO-3166 two letter country code |
| day_phone | string(25) | Day time phone |
| day_phone_e164 | (read only) string(25) | Day time phone (E164 format) |
| delivery_date | string (dateTime) | Date the customer is requesting delivery on. Typically used for perishable product delivery. |
| evening_phone | string(25) | Evening phone |
| first_name | string(30) | First name |
| last_name | string(30) | Last name |
| least_cost_route | boolean | If true, instructs UltraCart to apply the cheapest shipping method to this order. Used only for channel partner order inserts. |
| least_cost_route_shipping_methods | array of string | List of shipping methods to consider if least_code_route is true. Used only for channel parter order inserts. |
| lift_gate | boolean | Lift gate requested (LTL shipping methods only) |
| postal_code | string(20) | Postal code |
| rma | string(30) | RMA number |
| ship_on_date | string (dateTime) | Date the customer is requesting that the order ship on. Typically used for perishable product delivery. |
| ship_to_residential | boolean | True if the shipping address is residential. Effects the methods that are available to the customer as well as the price of the shipping method. |
| shipping_3rd_party_account_number | string(20) | Shipping 3rd party account number |
| shipping_date | (read only) string (dateTime) | Date/time the order shipped on. This date is set once the first shipment is sent to the customer. |
| shipping_department_status | string(30) | Shipping department status |
| shipping_method | string | Shipping method |
| shipping_method_accounting_code | (read only) string | Shipping method accounting code |
| special_instructions | string | Special instructions from the customer regarding shipping |
| state_region | string(32) | State |
| title | string(50) | Title |
| tracking_numbers | array of string | Tracking numbers |
| weight | (read only) Weight | Total weight of the items on the order |
| Name | Data Type | Description |
|---|---|---|
| error | Error | Error object if unsuccessful |
| metadata | ResponseMetadata | Meta-data about the response such as payload or paging information |
| orders | array of Order | orders |
| success | boolean | Indicates if API call was successful |
| Name | Data Type | Description |
|---|---|---|
| arbitrary_shipping_handling_total | Currency | Arbitrary shipping handling total, this is meaningless for updating an order. For inserting a new order, this will override any internal shipping and handlig totals and should only be used for orders completed outside the system. This will probably only ever be needed when submitting arbitrary taxes AND shipping is taxed. |
| other_refunded | (read only) Currency | Other refunded |
| shipping_handling_refunded | Currency | Shipping/handling refunded (read only except refund operation) |
| shipping_handling_total | Currency | Shipping/handling total |
| shipping_handling_total_discount | (read only) Currency | Shipping/handling total discount |
| subtotal | (read only) Currency | Subtotal |
| subtotal_discount | (read only) Currency | Subtotal discount |
| subtotal_discount_refunded | Currency | Subtotal discount refunded (read only except refund operation) |
| subtotal_refunded | (read only) Currency | Subtotal refunded |
| tax | Currency | Tax, may be updated to reflect any changes made to the tax fields, but cannot be used when inserting an order. For inserting, use the arbitrary fields instead. |
| tax_refunded | Currency | Tax refunded (read only except refund operation) |
| taxable_subtotal | (read only) Currency | Taxable subtotal |
| taxable_subtotal_discount | (read only) Currency | Taxable subtotal discount |
| total | (read only) Currency | Total |
| total_refunded | (read only) Currency | Total refunded |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(100) | Tag Value |
| Name | Data Type | Description |
|---|---|---|
| arbitrary_tax | number | Arbitrary Tax, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system. |
| arbitrary_tax_rate | number | Arbitrary tax rate, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system. |
| arbitrary_taxable_subtotal | number | Arbitrary taxable subtotal, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system. |
| tax_city_accounting_code | (read only) string | QuickBooks tax city code |
| tax_country_accounting_code | (read only) string | QuickBooks tax country code |
| tax_county | string(32) | County used for tax calculation purposes (only in the United States) |
| tax_county_accounting_code | (read only) string | QuickBooks tax county code |
| tax_gift_charge | (read only) boolean | True if gift charge is taxed |
| tax_postal_code_accounting_code | (read only) string | QuickBooks tax postal code code |
| tax_rate | number | Tax rate, this is meaningless for updating an order. For inserting a new order, if you need to override internal tax calculations, use the arbitrary fields. |
| tax_rate_city | (read only) number | Tax rate at the city level |
| tax_rate_country | (read only) number | Tax rate at the country level |
| tax_rate_county | (read only) number | Tax rate at the county level |
| tax_rate_postal_code | (read only) number | Tax rate at the postal code level |
| tax_rate_state | (read only) number | Tax rate at the state level |
| tax_shipping | (read only) boolean | True if shipping is taxed |
| tax_state_accounting_code | (read only) string | QuickBooks tax state code |
| Name | Data Type | Description |
|---|---|---|
| name | string | |
| value | string |
| Name | Data Type | Description |
|---|---|---|
| payload_name | string | Payload name |
| result_set | ResultSet | Result set |
| Name | Data Type | Description |
|---|---|---|
| count | integer (int32) | Number of results in this set |
| limit | integer (int32) | Maximum number of results that can be returned in a set |
| more | boolean | True if there are more results to query |
| next_offset | integer (int32) | The next offset that you should query to retrieve more results |
| offset | integer (int32) | Offset of this result set (zero based) |
| total_records | integer (int32) | The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true. |
| Name | Data Type | Description |
|---|---|---|
| uom | string | Unit of measure
Allowed Values
|
| value | number | Weight |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |