Duck, Goose & Chicken Hatchery

API Documentation

List of Error Codes Release Notes availability_get customer_get_address customer_set_address error_list function_list order_cancel order_change_shipdate order_confirm_provisional order_delete_provisional order_detail_option_list order_get order_list order_place order_report_loss order_search order_search_orderid order_update orders_export ship_method_get_list shipfor_partner_delete shipfor_partner_list shipfor_partner_remove_logo shipfor_partner_set_logo shipfor_partner_update sku_list sku_xref_add sku_xref_delete sku_xref_list sku_xref_update sku_xref_update_product_name sku_xref_update_upc substitutions_get_list

availability_get

Get a list of bird availabilty as of when this function is executed. The results are in list 'availability'. Each hash in that list has skuid, shipdate, available.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
include_sold true or false bool false Default is false. If true, include 'sold' in each output record that is a summary of the sales at the time this function is executed. The caller may use this to fine-tune the resulting availability in the case that the caller has orders that have not yet been sent to the client.
include_open_dates true or false bool false Default is true. If true, include a list of 'open' ship dates in the open_dates output list. An 'open' date has availability calculated and can be ordered against, provided all other checks pass.
include_eggs true or false bool false Default is true. If true, include hatching eggs in the list.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
availability List of availability records current as of the time this function was executed
availability.available Number of this item/SKU that are available
availability.shipdate Ship date on which this item/SKU is available
availability.skuid ID of the item/SKU that is available. See sku_list for more information about the SKUs.
availability.sold Only included if include_sold is true. A summary of the sales at the time this function is executed.
open_dates Only included if include_open_dates is true. A list of open ship dates.

customer_get_address

Retrieve the default shipping address for the given customer (our internal ID). This is available only to partners that are also a company with (possibly) multiple stores.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
customerid integer integer true The internal customer ID to retrieve.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
customerid The internal customer ID
firstname First name of recipient. May be blank for businesses.
initial Middle name/initial of recipient. May be blank for businesses.
lastname Last name of recipieint. May be full name of a business.
attn Attention line of shipping address
address1 Shipping address line 1
address2 Shipping address line 2
address3 Shipping address line 3
city Shipping city
state Shipping state
zip Shipping zip / postal code
country Shipping country
phone1 Shipping phone number 1
phone1ext Shipping phone number 1 (extension)
phone1type Shipping phone number 1 (type: 'home','work','mobile','fax','other')
phone2 Shipping phone number 2
phone2ext Shipping phone number 2 (extension)
phone2type Shipping phone number 2 (type: 'home','work','mobile','fax','other')

customer_set_address

Set the default shipping address for the given customer (our internal ID). This is available only to partners that are also a company with (possibly) multiple stores.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
customerid integer integer true The internal customer ID to set.
firstname string string false 100 First name of recipient. May be blank for businesses.
initial string string false 100 Middle name/initial of recipient. May be blank for businesses.
lastname string string true 100 Last name of recipieint. May be full name of a business.
attn string string false 200 Attention line of shipping address
address1 string string true 100 Shipping address line 1
address2 string string false 100 Shipping address line 2
address3 string string false 100 Shipping address line 3
city string string true 100 Shipping city
state string string true 100 Shipping state
zip 5 or 9 digit US zip code zip true 50 Shipping zip / postal code
country string string true 50 Shipping country
phone1 10 digit phone number, no spaces or punctuation phone true Shipping phone number 1
phone1ext string string false 10 Shipping phone number 1 (extension)
phone1type phone_type false Shipping phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
phone2 10 digit phone number, no spaces or punctuation phone false Shipping phone number 2
phone2ext string string false 10 Shipping phone number 2 (extension)
phone2type phone_type false Shipping phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

error_list

Get a list of all known error codes and the description mask for each.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
errors List of all known API errors
errors.error_code Unique integer error code. The error_code field uniquely identifies an error condition and will be mostly stable over the lifespan of the API.
errors.description Description of the error. These descriptions may change over time.

function_list

Return a complete list of API functions, any required parameters for each, and a description of the output fields

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
functions List of available API functions
functions.function_name Name of the API function - case sensitive
functions.description Description of the function - operation, inputs and outputs
output_fields List of output fields of the function
output_fields.name Name of the output field
output_fields.description Description of the output field
parameters List of parameters to the function
parameters.name Name of the parameter, case sensitive
parameters.required Is the parameter always required?
parameters.type Type/format of the parameter value
parameters.max_length Maximum length of the string parameter
parameters.list_entry_type If this is a list, the type of entries that are allowed in the list
parameters.description Description of the parameter
parameters.format format of the parameter
parameters.valid_values List of valid values for this parameter

order_cancel

Cancel an order. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system. If the cancel is successful, the output fields are the same as order_get.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier
note string string false 500 Optional note to record on the order when it is caneled. This note may not ever be seen by anyone, but it will be on the records of the order.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

order_change_shipdate

Change the shipping date of an order. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system. If the update is successful, the output fields are the same as order_get.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier
assign_ship_date true or false bool false Default is false. If true, assign the first ship date on which the entire order is available. You must specify exactly one of assign_ship_date=true and ship_date.
ship_date yyyy-mm-dd date false Date on which this order is to ship. You must specify exactly one of assign_ship_date=true and ship_date.
carry_along true or false bool false Default is unspecified. If specified, the carry_along value of the order is changed to the specified value. Has this order been carried along, that is, delayed because of insufficient inventory.
error_on_no_change true or false bool false Default is true. If true, an error returned if no change in ship date is detected. If false, no error is returned if no change in ship date is detected.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

order_confirm_provisional

Confirm a provisional order. A provisional order must be confirmed within 5 - 10 minutes of being placed or it will be automatically deleted. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

order_delete_provisional

Delete a provisional order. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

order_detail_option_list

List the order detail options that are available. If a skuid is provided, lists only the options that are available for that SKU.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer false If provided, list only the options that are available for the given SKU.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
options List of available options
options.optiondefid ID of this option. This is the field that is to be used in order_place and order_update.
options.shortname A short name for this option. May change over time.
options.description Description of this option. May change over time.
options.sku_type Description of the type of SKU to which this option may apply.
options.sku_sub_type Description of the sub-type of SKU to which this option may apply. Is not defined for all options.

order_get

Get all available details for a single order, using the internal order ID

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer true Internal ID of the order to retrieve
include_packslip true or false bool false Default is false. If true, include a copy of the packing slip that will be included with the order.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
orderid The internal ID of this order. This is the field that must be used in other functions to manipulate orders, except those that specifically search or retrieve by external order ID.
canceled Is this order canceled? A canceled order will not ship or be billed/invoiced.
ship_date Currently assigned ship date, yyyy-MM-dd
ship_date_original The original assigned ship date, yyyy-MM-dd
created Date/time this order was first created in the system
can_bypass_availability Can the date on this order be changed to a date on which there is not enough calculated availability for the birds in the order. This may be set by the client in situations where an order cannot ship because of a shortage of birds (carry along).
shipforid ID of your ship-for partner that we are shipping this order for
store_number The store number (yours) that this order belongs to.
shipfor_orderid ID of the order in your ship-for partner's system
packslip If include_packslip is true, this is the base64 encoded bytes of the packing slip (PDF)
packslip_note Optional customer-visible note to be included on the packing slip
small_order_charge The small order charge that applies to this order
shipping_surcharge A shipping surcharge imposed by the shipping carrier, usually USPS.
ship_address Structure that shows the current shipping address of this order
ship_address.firstname First name of recipient. May be blank for businesses.
ship_address.initial Middle name/initial of recipient. May be blank for businesses.
ship_address.lastname Last name of recipieint. May be full name of a business.
ship_address.attn Attention line of shipping address
ship_address.address1 Shipping address line 1
ship_address.address2 Shipping address line 2
ship_address.address3 Shipping address line 3
ship_address.city Shipping city
ship_address.state Shipping state
ship_address.zip Shipping zip / postal code
ship_address.country Shipping country
ship_address.phone1 Shipping phone number 1
ship_address.phone1ext Shipping phone number 1 (extension)
ship_address.phone1type Shipping phone number 1 (type: 'home','work','mobile','fax','other')
ship_address.phone2 Shipping phone number 2
ship_address.phone2ext Shipping phone number 2 (extension)
ship_address.phone2type Shipping phone number 2 (type: 'home','work','mobile','fax','other')
physical_address Structure that shows the current physcial address of this order. The physical address should be used if the order is a bird order being shipped to a PO box. The physical address is used for the NPIP VS9-3 form.
physical_address.firstname First name of physcial address recipient. May be blank for businesses.
physical_address.initial Middle name/initial of physcial address recipient
physical_address.lastname Last name of physcial address recipieint. May be full name of a business.
physical_address.attn Attention line of physcial address
physical_address.address1 Physical address line 1
physical_address.address2 Physical address line 2
physical_address.address3 Physical address line 3
physical_address.city Physical city
physical_address.state Physical state
physical_address.zip Physical zip / postal code
physical_address.country Physical country
physical_address.phone1 Physical phone number 1
physical_address.phone1ext Physical phone number 1 (extension)
physical_address.phone1type Physical phone number 1 (type: 'home','work','mobile','fax','other')
physical_address.phone2 Physical phone number 2
physical_address.phone2ext Physical phone number 2 (extension)
physical_address.phone2type Physical phone number 2 (type: 'home','work','mobile','fax','other')
partner_orderid The partner's unique identifier for this order (external ID)
po_number The partner's purchase order (PO) number, if any
provisional If true, this is a provisional / temporary order that must be confirmed (order_confirm_provisional) within a short timeframe (5 - 10 minutes) or it will be deleted. The order may be expicitly deleted with order_delete_provisional.
carry_along Has this order been 'carried along' = delayed due to insufficient hatched birds
ship_method Shipping method assigned to this order
substitutions What type of subsitiutions are allowed on this order if there are not enough of the requested items? similar_breeds=substitute from similar breeds. from_order=substitute from other breeds listed in the order. Blank or missing means no substitutions are allowed.
tracking_numbers List of tracking numbers for this order. Orders may have more than one shipment.
tracking_numbers.carrier The carrier with which this package was shipped
tracking_numbers.tracking_number The carrier's tracking number for this shipment
tracking_numbers.delivery_status The carrier's delivery status as of the last time retrieved it
tracking_numbers.delivery_status_delivered true/false: is the package is considered delivered?
details List of details (line items) in the order
details.skuid SKU ID of this item (internal identifier)
details.quantity Quantity of this item included in the order
details.price Unit price of this line item
details.description Description of this line item, including SKU name and list of selected options
details.skuname Name/description of the SKU
details.options_description String description of the included options
details.additional_info Optional additional information to print on the pack slip.
details.options List of options that apply to this order detail item.
details.options.optiondefid Internal ID of the option.
details.options.shortname Short name of the option. May change over time.
details.options.description Full description of the option. May change over time.
additional_emails Optional list of additional email addresses that will be notified of: new order placed, order updated, order shipped with tracking numbers.
additional_emails.email_address The email address to be notified.
additional_emails.show_pricing Show pricing information to this recipient?

order_list

Get a list of orders matching the given partner order ID (external ID) exactly

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
partner_orderid string string true Partner / external order number

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
orders List of matching orders. The format of each order is exactly the same as that produced by order_get.

order_place

Place a new order. If successful, the output will be the same as the order_list function. Most invocations of this function should result in a single order, but it is possible that multiple orders will result.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
partner_orderid string string true 60 Partner's unique order identfier
single_order_only true or false bool false Default is true. Certain combination of items ordered could result in multiple orders in our system (e.g. birds and non-lives in the same order). If this value is true, and the incoming order would result in multiple orders in our system, the order will be rejected with a 1072 error. If this value is false, multiple internal orders are allowed. If a single incoming order results in multiple internal orders, you will not be able to use partner_orderid as the 'key' in functions that operate on a single order (order_cancel, order_change_shipdate, order_update).
assign_ship_date true or false bool false Default is false. If true, assign the first ship date on which the entire order is available. You must specify exactly one of assign_ship_date=true and ship_date.
ship_date yyyy-mm-dd date false Date on which this order is to ship. You must specify exactly one of assign_ship_date=true and ship_date.
customerid integer integer false If provided, place the order for this specific customer (our internal ID). This is available only to partners that are also a company with (possibly) multiple stores.
placed_by_customerid integer integer false ID of the customer (store) that is placing this order. This is available only to partners that are also a company with (possibly) multiple stores and is required in that case.
shipforid integer integer false ID of the ship-for partner that you are shipping this order for "2nd level drop ship"
shipfor_orderid string string false If shipforid is present, this is the ID of tne order in your ship-for partner's system and will appear on the packing slip
ship_address hash_not_empty true Structure that shows the current shipping address of this order
ship_address.firstname string string false 100 First name of recipient. May be blank for businesses.
ship_address.initial string string false 100 Middle name/initial of recipient. May be blank for businesses.
ship_address.lastname string string true 100 Last name of recipieint. May be full name of a business.
ship_address.attn string string false 200 Attention line of shipping address
ship_address.address1 string string true 100 Shipping address line 1
ship_address.address2 string string false 100 Shipping address line 2
ship_address.address3 string string false 100 Shipping address line 3
ship_address.city string string true 100 Shipping city
ship_address.state string string true 100 Shipping state
ship_address.zip 5 or 9 digit US zip code zip true 50 Shipping zip / postal code
ship_address.country string string true 50 Shipping country
ship_address.phone1 10 digit phone number, no spaces or punctuation phone true Shipping phone number 1
ship_address.phone1ext string string false 10 Shipping phone number 1 (extension)
ship_address.phone1type phone_type false Shipping phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
ship_address.phone2 10 digit phone number, no spaces or punctuation phone false Shipping phone number 2
ship_address.phone2ext string string false 10 Shipping phone number 2 (extension)
ship_address.phone2type phone_type false Shipping phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other
physical_address hash_not_empty false Structure that shows the physcial address of this order. The physical address is required if the order is a bird order being shipped to a PO box. The physical address is used for the NPIP VS9-3 form. If there is not a physical address, omit this field.
physical_address.firstname string string false 100 First name of physical address recipient. May be blank for businesses.
physical_address.initial string string false 100 Middle name/initial of physical address recipient. May be blank for businesses.
physical_address.lastname string string true 100 Last name of physical address recipieint. May be full name of a business.
physical_address.attn string string false 200 Attention line of Physical address
physical_address.address1 string string true 100 Physical address line 1
physical_address.address2 string string false 100 Physical address line 2
physical_address.address3 string string false 100 Physical address line 3
physical_address.city string string true 100 Physical city
physical_address.state string string true 100 Physical state
physical_address.zip 5 or 9 digit US zip code zip true 50 Physical zip / postal code
physical_address.country string string true 50 Physical country
physical_address.phone1 10 digit phone number, no spaces or punctuation phone true Physical phone number 1
physical_address.phone1ext string string false 10 Physical phone number 1 (extension)
physical_address.phone1type phone_type false Physical phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
physical_address.phone2 10 digit phone number, no spaces or punctuation phone false Physical phone number 2
physical_address.phone2ext string string false 10 Physical phone number 2 (extension)
physical_address.phone2type phone_type false Physical phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other
internal_note string string false 5000 Internal-only note. Customer will not see this. Partner may not see it.
packslip_note string string false 100 Customer-visible note to print on pack slip
ship_method valid shipping method ship_method false Optional shipping method
EGGS Eggs Best Way 3 day
EXPR Express Mail
PRI Priority Mail
carry_along true or false bool false Default is false. Has this order been carried along, that is, delayed because of insufficient inventory
po_number string string false 30 Partner's purchase order number
substitutions valid substitutions value substitutions false What type of substitutions are allowed if there are not enough of a given item.
none No substitutions allowed
similar_breeds Substitute with similar breeds
from_order Substitute only from breeds in the order
vaccinate true or false bool false If client operates with order-level vaccinations, this must be a boolean indicating whether or not the order is to be vaccinated
provisional true or false bool false Default is false. If true, this is a provisional / temporary order that must be confirmed (order_confirm_provisional) within a short timeframe (5 - 10 minutes) or it will be deleted. The order may be expicitly deleted with order_delete_provisional.
details list_not_empty hash_not_empty true List of details (line items) in the order
details.skuid integer integer true SKU ID of this item (internal identifier)
details.quantity integer integer true Quantity of this item to include in the order
details.additional_info string string false 100 Optional additional information to print on the pack slip as part of the item description.
details.note string string false 50 Optional additional information to print on the pack slip in a separate column.
details.options list integer false Optional list of order detail options. Specify a list of the optiondefid values retrieved from order_detail_option_list
additional_emails list_not_empty hash_not_empty false Optional list of additional email addresses that will be notified of: new order placed, order updated, order shipped with tracking numbers. Omit this parameter if there are none.
additional_emails.email_address valid email address email_address true The email address that is to receive the notifications.
additional_emails.show_pricing true or false bool true Should the notifications to this email address include pricing?

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
orders List of orders that resulted from this call. Each is a JSON hash formatted like the output of order_get.
order_count Number of internal orders resulting from this function execution.

order_report_loss

Report losses on an order. If the losses are approved, the loss amount will be reported as a credit on the order and the amount due approprirately reduced. There is no return value if the losses are approved. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system. If allowed, and the order has already been invoiced, the credit from losses will be added to another shipped but un-invoiced order.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier
losses list_not_empty hash_not_empty true List of losses to report against this order.
losses.skuid integer integer true SKU ID of this item. Each combination of skuid+loss_code must appear only one.
losses.quantity integer integer true The number of losses being reported for this SKU ID and loss code
losses.loss_code valid loss code (see list) loss_code true The type of loss being reported.
Defective Defective
DOA DOA
Loss Loss
Loss after 48 Loss after 48
Missing Missing
Sexing error Sexing error

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

order_search

Search for orders by the given criteria

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
from_ship_date yyyy-mm-dd date true Search from this ship date. If through_ship_date is omitted, only orders matching this date are returned.
through_ship_date yyyy-mm-dd date false Search through this ship date. If this date is omitted, only orders matching from_ship_date are returned.
search_term string string false If provided, only return orders that match this search term in the customer name, city, state, our order ID (exact) or your ID (partial).
include_tracking_numbers true or false bool false Default is false. If true, include tracking numbers for the resulting orders
include_details true or false bool false Default is false. If true, include item details for the resulting orders. This could result in a very large response.
partner_orderid string string false If provided, only return orders where your order ID matches this value, case insensitive.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
orders List of matching orders. The format of each order is exactly the same as that produced by order_get, depending on the values of parameters include_details and include_tracking_numbers.

order_search_orderid

Get a list of orders matching the given order ID exactly. Searches in partner order ID, client order ID, PO number.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid string string true Orderid to search for

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
orders List of matching orders. The format of each order is exactly the same as that produced by order_get.

order_update

Update an order based on the parameters supplied to the function. You must specify at least one of orderid and partner_orderid. If you specify both, the orderid must match the order with the given partner_orderid in our system. Only those parameters that are specified are updated. If the update is successful, the output is the same as order_get. Note: certain order checks are invoked when this function is executed, even if nothing changes on the order. It is feasible that that rules could have changed since the order was first placed, resulting in an error here when none was present when the order was first placed. If this happens, you need to take steps to correct or cancel the order.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
orderid integer integer false Internal ID of the order to cancel
partner_orderid string string false 60 Partner's unique order identfier
new_partner_orderid string string false 60 New value of partner's unique order identfier. The new value must not be the same as another un-canceled order in the system.
carry_along true or false bool false Default is false. Has this order been carried along, that is, delayed because of insufficient inventory. Only updated if this key is present.
assign_ship_date true or false bool false Default is false. If true, assign the first ship date on which the entire order is available. You may specify exactly one of assign_ship_date=true and ship_date.
ship_date yyyy-mm-dd date false Date on which this order is to ship. You may specify exactly one of assign_ship_date=true and ship_date.
shipforid integer integer_optional false ID of the ship-for partner that you are shipping this order for "2nd level drop ship"
shipfor_orderid string string false If shipforid is present, this is the ID of tne order in your ship-for partner's system and will appear on the packing slip
ship_address hash_not_empty false Structure that shows the current shipping address of this order. If included, all of the address fields must be present.
ship_address.firstname string string false 100 First name of recipient. May be blank for businesses.
ship_address.initial string string false 100 Middle name/initial of recipient. May be blank for businesses.
ship_address.lastname string string true 100 Last name of recipieint. May be full name of a business.
ship_address.attn string string false 200 Attention line of shipping address
ship_address.address1 string string true 100 Shipping address line 1
ship_address.address2 string string false 100 Shipping address line 2
ship_address.address3 string string false 100 Shipping address line 3
ship_address.city string string true 100 Shipping city
ship_address.state string string true 100 Shipping state
ship_address.zip 5 or 9 digit US zip code zip true 50 Shipping zip / postal code
ship_address.country string string true 50 Shipping country
ship_address.phone1 10 digit phone number, no spaces or punctuation phone true Shipping phone number 1
ship_address.phone1ext string string false 10 Shipping phone number 1 (extension)
ship_address.phone1type phone_type false Shipping phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
ship_address.phone2 10 digit phone number, no spaces or punctuation phone false Shipping phone number 2
ship_address.phone2ext string string false 10 Shipping phone number 2 (extension)
ship_address.phone2type phone_type false Shipping phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other
physical_address hash_not_empty false Structure that shows the physcial address of this order. The physical address is required if the order is a bird order being shipped to a PO box. The physical address is used for the NPIP VS9-3 form. If included, all of the address fields must be present.
physical_address.firstname string string false 100 First name of physical address recipient. May be blank for businesses.
physical_address.initial string string false 100 Middle name/initial of physical address recipient. May be blank for businesses.
physical_address.lastname string string true 100 Last name of physical address recipieint. May be full name of a business.
physical_address.attn string string false 200 Attention line of Physical address
physical_address.address1 string string true 100 Physical address line 1
physical_address.address2 string string false 100 Physical address line 2
physical_address.address3 string string false 100 Physical address line 3
physical_address.city string string true 100 Physical city
physical_address.state string string true 100 Physical state
physical_address.zip 5 or 9 digit US zip code zip true 50 Physical zip / postal code
physical_address.country string string true 50 Physical country
physical_address.phone1 10 digit phone number, no spaces or punctuation phone true Physical phone number 1
physical_address.phone1ext string string false 10 Physical phone number 1 (extension)
physical_address.phone1type phone_type false Physical phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
physical_address.phone2 10 digit phone number, no spaces or punctuation phone false Physical phone number 2
physical_address.phone2ext string string false 10 Physical phone number 2 (extension)
physical_address.phone2type phone_type false Physical phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other
internal_note string string false 5000 Internal-only note. Customer will not see this. Partner may not see it. If specified, this note is ADDED to the order unless there is already a note with the same text (case insenstivite).
packslip_note string string false 100 Customer-visible note to print on pack slip. If specified, this completely replaces any existing pack slip note. Specify an empty note to remove the pack slip note from the order.
ship_method valid shipping method ship_method false Optional shipping method
EGGS Eggs Best Way 3 day
EXPR Express Mail
PRI Priority Mail
po_number string string false 30 Partner's purchase order number. To remove the PO number, specify a blank value.
substitutions valid substitutions value substitutions false What type of substitutions are allowed if there are not enough of a given item.
none No substitutions allowed
similar_breeds Substitute with similar breeds
from_order Substitute only from breeds in the order
vaccinate true or false bool false If client operates with order-level vaccinations, this must be a boolean indicating whether or not the order is to be vaccinated
details list hash_not_empty false List of details (line items) in the order. If details is specified, the list must be a complete list of the items that are to remain on the order. Any items not included in this list will be removed. You may change quantities. The changes will be accepted depending on availability.
details.skuid integer integer true SKU ID of this item (internal identifier)
details.quantity integer integer true Quantity of this item to include in the order
details.additional_info string string false 100 Optional additional information to print on the pack slip as part of the item description. If this field is missing or has an empty value, any existing additional_info will be removed from the order for this item.
details.note string string false 50 Optional additional information to print on the pack slip in a separate column. If this field is missing or has an empty value, any existing note will be removed from the order for this item.
details.options list integer false Optional list of order detail options. Specify a list of the optiondefid values retrieved from order_detail_option_list. You must specify the options that you wish to retain. If this list is missing or empty, any existing options will be removed from this order detail item.
additional_emails list hash_not_empty false Optional list of additional email addresses that will be notified of: new order placed, order updated, order shipped with tracking numbers. If this parameter is omitted, no change will be made to the existing list of email addresses for this order. If specified, the list here will completely replace the list on the order. To remove all existing email address from the order, specify an empty list.
additional_emails.email_address valid email address email_address true The email address that is to receive the notifications.
additional_emails.show_pricing true or false bool true Should the notifications to this email address include pricing?

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

orders_export

Create an export file (format Excel .xls) of orders in the given date range. Rows are breed/sex, columns are dates.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
export_from yyyy-mm-dd date true Beginning ship date of orders in the export file.
export_through yyyy-mm-dd date false Ending ship date of orders in the export file. If omitted, all orders on or after export_from are exported.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
xls Base64 encoded content of the export file (Excel .xls).

ship_method_get_list

Get a list of valid ship methods.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
list List of all valid ship methods
list.code Ship method code to use in API function calls
list.description Description of the ship method.

shipfor_partner_delete

Delete a ship-for partner. A ship-for partner may only be deleted if there a no orders in the system related to that partner, whether active, shipped or canceled.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
shipforid integer integer true ID of the shipfor partner to delete.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

shipfor_partner_list

Return a list of existing ship-for partners.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
partners List of ship-for partners
partners.shipforid ID of this shipfor partner. This ID must be used when updating or deleting a partner.
partners.logo_filename Name of the logo image to put on the pack slip for orders ship for this shipfor partner.
partners.packslip_text Arbitrary text to put on the pack slip for orders ship for this shipfor partner.
partners.address The name and address of the ship-for partner as it will appear on the packing slip.
partners.address.addressname Short name of this address. Unused in this context.
partners.address.firstname First name of the ship-for partner. If the partner is a business, the business name should be in the lastname field.
partners.address.initial Middle initial of the ship-for partner. If the partner is a business, the business name should be in the lastname field.
partners.address.lastname Last name of the ship-for partner. If the partner is a business, the business name should be in the lastname field.
partners.address.attn Attention line of this partner. Unused in this context.
partners.address.address1 Partner address line 1
partners.address.address2 Partner address line 2
partners.address.address3 Partner address line 3
partners.address.city Partner address city
partners.address.state Partner address state abbeviation
partners.address.zip Partner address zipcode (US 5 digit or 5+4)
partners.address.country Partner address county code (2 character)
partners.address.phone1 Partner address phone 1 - compressed
partners.address.phone1ext Partner address phone 1 extension
partners.address.phone1type Partner address phone 1 type
partners.address.phone2 Partner address phone 2 - compressed
partners.address.phone2ext Partner address phone 2 extension
partners.address.phone2type Partner address phone 2 type
partners.logoImage Structure defining the logo image to appear on packing slips for this partner
partners.mime_type The mime type of the image
partners.filename The original filename of the image
partners.image The bytes of the image, base64 encoded

shipfor_partner_remove_logo

Remove the logo from a ship-for partner.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
shipforid integer integer true ID of the shipfor partner to update.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

shipfor_partner_set_logo

Set the logo image for a ship-for partner. The logo must be an SVG or a PNG or JPG that is exactly 300 x 300 pixels.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
shipforid integer integer true ID of the shipfor partner to update.
mime_type string string true 100 Mime type of the logo image. Valid values are: image/svg+xml, image/png, image/jpg
filename string string true 200 Original filename of the logo image. Must not include path information, only the file name.
image string string true base64 encoded image bytes

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
mime_type The mime type of the saved image
filename The filename of the saved image
image The base64 encoded bytes of the saved image

shipfor_partner_update

Add or update a ship-for partner

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
shipforid integer integer false ID of the shipfor partner to update. Omit for a new ship-for partner.
packslip_text string string false 500 Optional text put on pack slips for orders for this ship-for partner.
address hash_not_empty true Structure that contains the name and address of this ship-for partner.
address.firstname string string false 100 First name of ship-for partner. May be blank for businesses.
address.initial string string false 100 Middle name/initial of ship-for partner. May be blank for businesses.
address.lastname string string true 100 Last name of ship-for partner. If a business, put the full name here.
address.address1 string string true 100 Address line 1
address.address2 string string false 100 Address line 2
address.address3 string string false 100 Address line 3
address.city string string true 100 City
address.state string string true 100 State
address.zip 5 or 9 digit US zip code zip true 50 Zip / postal code
address.country string string true 50 Country
address.phone1 10 digit phone number, no spaces or punctuation phone true Phone number 1
address.phone1ext string string false 10 Phone number 1 (extension)
address.phone1type phone_type true Phone number 1 (type)
home home
work work
mobile mobile
fax fax
other other
address.phone2 10 digit phone number, no spaces or punctuation phone false Phone number 2
address.phone2ext string string false 10 Phone number 2 (extension)
address.phone2type phone_type false Phone number 2 (type)
home home
work work
mobile mobile
fax fax
other other

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
shipforid The ID of the ship-for partner that was added or updated.

sku_list

Return a list of SKUs. Only SKUs with active=true can be included in an order.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
skus List of items/SKUs
skus.skuid ID of this item/SKU. This is the field that is referenced by other functions.
skus.sku Alphanumeric SKU designation. This is a shorthand notation for the item and generally also indicates the breed.
skus.sex Sex of this item. M=male, F=female, S=straight run / unsexed, blank=not a sexed item (e.g. non live)
skus.name Name of this SKU/item
skus.active Is this SKU active? Only SKUs with active=true can be ordered.
skus.type Description of the type of item. May change over time.
skus.subtype Description of the sub-type of item. May change over time. Is not present on all SKUs.
skus.isbn ISBN of the item. Only present if applicable.
skus.upc UPC of the item. Only present if applicable.

sku_xref_add

Add a new SKU cross reference record. Returns the added record.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer true Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id string string true 20 Partner's SKU/ID for this item
upc string string false 20 Optional UPC of the item
product_name string string false 200 Partner's name/description of this item

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
skuid Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id Partner's SKU/ID for this item
upc Optional UPC of the item
product_name Partner's name/description of this item

sku_xref_delete

Update an existing SKU cross reference record. The skuid and company_product_id parameters are used to locate the record to update, so there must be a single record that matches those.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer true Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id string string true 20 Partner's SKU/ID for this item

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

sku_xref_list

List all of the SKU cross reference records

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
xrefs List of items/SKUs
xrefs.skuid Internal ID of this item/SKU. This is the field that is referenced by other functions.
xrefs.company_product_id Partner's SKU/ID for this item
xrefs.upc Optional UPC of the item
xrefs.product_name Partner's name/description of this item

sku_xref_update

Update an existing SKU cross reference record. The skuid and company_product_id parameters are used to locate the record to update, so there must be a single record that matches those. The other paramters are fields that can be updated.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer true Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id string string true 20 Partner's SKU/ID for this item
upc string string false 20 Optional UPC of the item. If this field is not included in the parameters, it is set to null.
product_name string string false 200 Partner's name/description of this item. If this field is not included in the parameters, it is set to null.

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.

sku_xref_update_product_name

Update the product name of an existing SKU cross reference record

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer true Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id string string true 20 Partner's SKU/ID for this item
product_name string string false 200 Partner's name/description of this item

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
skuid Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id Partner's SKU/ID for this item
upc Optional UPC of the item
product_name Partner's name/description of this item

sku_xref_update_upc

Update the UPC of an existing SKU cross reference record

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values
skuid integer integer true Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id string string true 20 Partner's SKU/ID for this item
upc string string false 20 Optional UPC of the item

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
skuid Internal ID of this item/SKU. This is the field that is referenced by other functions.
company_product_id Partner's SKU/ID for this item
upc Optional UPC of the item
product_name Partner's name/description of this item

substitutions_get_list

Get a list of valid substitutions values.

Parameters

Name Format Type List Entry Type Required Max Length Description Valid Values

Output Fields

Name Description
_environment Notation of the environment in which the response was generated. For internal troubleshooting.
_hostname Notation of the host on which the response was generated. For internal troubleshooting.
list List of all valid substitutions values
list.code Code to use in API function calls
list.description Description of the substitution value

Error Codes

Some error responses will include an error_fields hash which contains structured fields describing the data elements in the error message. If an error code supports this, those fields will be listed in the Description column for that error code. If an error code does not support structured data and you would like it to, please contact us.
Code Description
1000 API request is not POST
1001 POST body missing
1002 JSON invalid: {0}
1003 Content-Type must be {0}
1004 Header X-Payload-Hash missing
1005 An internal error occurred {0,date,yyyy-MM-dd HH:mm:ssXXX}
1006 username missing from JSON hash
1007 Invalid username and/or password specified
1008 Internal setup error, password or salt missing from partner record
1009 Value of X-Payload-Hash is invalid, does not match the hash of the JSON payload
1010 password missing from JSON hash
1011 An internal error occurred {0,date,yyyy-MM-dd HH:mm:ssXXX}
1012 function missing from JSON hash
1013 Invalid function name [{0}]
1014 Your account has been locked out due to multiple authentication failures
1015 IP address {0} is not allowed
1016 Cannot determine IP address
1017 Order {0,number,0} not found
Error Field Description
orderid The requested Order ID
1018 Required parameter {0} missing
1019 Parameter {0} does not match the correct format
1020 Dummy error for testing
1021 Parameter {0} must be a JSON list
1022 Parameter {0} must be a non-empty JSON list
1023 Parameter {0} must be a JSON hash
1024 Parameter {0} must be a non-empty JSON hash
1025 Entry index {0} in list {1} is not type {2}
1026 Parameter {0} should be {1} not {2}
1027 Parameter {0} does not match the correct format: {1}
1028 Parameter {0} exceeds maximum allowed length of {1}
1029 Parameter {0} is invalid: {1}
1030 Parameter {0} is invalid, valid values are: {1}
1031 There are already {0} un-canceled orders in the system with partner_orderid={1}
1032 ship_date for a new order may not be in the past
1033 {0,date,yyyy-MM-dd} is not a valid ship date
1034 The shipping address is invalid: {0}
1035 The shipping address is incomplete: {0}
1036 The physical address is invalid: {0}
1037 The physical address is incomplete: {0}
1038 skuid {0,number,0} is invalid
1039 skuid {0,number,0} ({1}) is inactive
1040 skuid {0,number,0} ({1}) is not allowed
1041 Availability problem: There are not enough of skuid {0,number,0} ({1}) on the ship_date {3,date,yyyy-MM-dd}. Requested: {2}.
Error Field Description
quantity The quantity of skuid that was requested
ship_date The ship date that was requested (yyyy-mm-dd)
sku_description Our name/description of the SKU that was requested
skuid Our internal SKU ID of the item that was requested
1042 Setup problem: API user not found
1043 The physical_adddress may not be a PO box
1044 A physical address is required. {0}
1045 Cart rule error: {0}
1046 vaccinate missing. Must be true or false - should this order be vaccinated?
1047 Order post error: {0}
1048 Could not assign ship date {0,date,yyyy-MM-dd} to skuid {1,number,0} ({2}). The ship date may not be enabled for optimization - check with {3} to confirm.
1049 Could not find a price for skuid {0,number,0} ({1})
1050 substitutions=from_order was specified, but there are not at least 2 breeds in the order. Assortments/mixes do not count as breeds in this context.
1051 Setup error: your partner record is not marked as having unique order numbers. Contact {0} for assistance.
1052 Invalid state in ship_address: {0}
1053 Invalid US zip code in ship_address: {0}
1054 State {0} does not match zip code {1} in ship_address
1055 Invalid state in physical_address: {0}
1056 Invalid US zip code in physical_address: {0}
1057 State {0} does not match zip code {1} in physical_address
1058 You must specify exactly one of assign_ship_date=true and ship_date
1059 assign_ship_date=true was specified but there are no dates on which the entire order is available
1060 skuid {0,number,0} ({1}) may not ship to the specified address: {2}
1061 You may not order more than {0} of skuid {1,number,0} ({2}), you requested {3}
1062 You may not order more than {0} of breed {1}, you requested {2}
1063 Order {0,number,0} is already canceled
1064 You may not update or cancel order {0,number,0} because the packslip has already printed
1065 You may not update or cancel order {0,number,0} because the ship date is closed (no more changes allowed)
1066 You may not update or cancel order {0,number,0} because it has alerady shipped (has tracking numbers)
1067 Cancellation of order {0,number,0} failed: {1}
1068 You must specify at least one of orderid or partner_orderid
1069 There are no un-canceled orders matching partner_orderid {0}
1070 There are too many ({0}) un-canceled orders matching partner_orderid {1}
1071 The partner_orderid on order {0,number,0} does not match the specified partner_orderid {1}
1072 Order rejected because it would result in {0} internal orders and single_order_only defaulted or was specified as true.
1073 This function is still in development
1074 Order {0,number,0} is already set to ship date {1,date,yyyy-MM-dd}
1075 assign_ship_date=true was specified but there are no other dates on which the entire order is available
1076 assign_ship_date=true was specified but the currently assigned ship date of {0,date,yyyy-MM-dd} is the earliest date available
1077 You may not update or cancel order {0,number,0} because the ship date is on or before today
1078 Date change of order {0,number,0} to {1,date,yyyy-MM-dd} failed: {2}
1079 new_partner_orderid may not be blank/empty
1080 internal_note may not be blank/empty
1081 Update of order details failed: {0}
1082 Could not assign ship date {0,date,yyyy-MM-dd} to skuid {1,number,0} ({2}) because there is no eggset for that breed on that date. This means that we are not hatching any of that breed on that date. This error cannot be overriden by an order-level override to availability.
1083 Availability problem: There are not enough of skuid {0,number,0} ({1}) on the ship_date {3,date,yyyy-MM-dd}. Requested: {2}. There is no eggset for that breed on that date. This means that we are not hatching any of that breed on that date. This error cannot be overriden by an order-level override to availability.
1084 There are too many hatch event records matching ship date {0,date,yyyy-MM-dd}
1085 We are not currently accepting orders with a ship date on or after {0,date,yyyy-MM-dd}
1086 You must order at least {0,number} of [{1}], you only have {2,number}.
1087 You may not cancel this order. Please contact us for assistance.
1088 This function is not enabled. Please contact us for assistance.
1089 You may not report losses against this order because it has not shipped (no ship history records).
1090 You may not report losses against this order because it has been {0,number} days since the ship date - the maximum allowed for reporting losses is {1,number}.
1091 You may not report losses against this order because it has already been invoiced.
1092 skuid {0,number,0} ({1}) is not included in this order
1093 The minimum quantity for a loss report is 0
1094 You attempted to report losses for {0,number} of skuid {1,number,0} ({2}) but only {3,number} are included in the order.
1095 You attempted to report losses for {0,number} of skuid {1,number,0} ({2}) but {3,number} losses have already been reported against the original {4,number} in the order, leaving only {5,number} remaining.
1096 Loss code [{0}] specified more than once for skuid {1,number,0} ({2}).
1097 An unexpected error occurred during loss reporting: {0}
1098 You are not allowed to report losses via the API/Portal. Please contact us for assistance.
1099 shipforid {0,number,0} was not found for update/delete
1100 shipforid {0,number,0} specified for update/delete does not belong to you
1101 Validation of ship-for partner failed: {0}
1102 shipforid {0,number,0} may not be deleted because there are orders in the system that reference it.
1103 shipfor_orderid may only be specified if shipforid is specified
1104 shipforid {0,number,0} was not found
1105 shipforid {0,number,0} does not belong to you
1106 Invalid mime type for logo image. Valid types are: {0}.
1107 The supplied logo filename does not have an extension. The filename must have an extension that matches the mime type.
1108 The extension of the logo filename ({0}) maps to a mime type of {1} which is not the same as the supplied mime type of {2}.
1109 The supplied logo image is missing or invalid.
1110 The SVG logo image could not be used: {0}
1111 The provided logo image is unusable.
1112 The provided logo must be exactly 300x300 pixels. The actual size is {0,number,0}x{1,number,0} pixels.
1113 The internal format of the image appears to be {0}. The only allowed values are: {1}.
1114 shipforid {0,number,0} does not have a logo to remove
1115 Cannot report losses for order {0,number,0} because there are no shipped and un-invoiced orders to which the credit amount of {1,number,$#,##0.00} can be applied.
1116 Cannot report losses for order {0,number,0} because there is insufficient balance on shipped and un-invoiced orders to cover the credit amount of {1,number,$#,##0.00}.
1117 Order {0,number,0} is not a provisional order.
1118 Order {0,number,0} is a provisional order and may not be changed nor canceled.
1119 You are not allowed to place an order for customerid {0,number,0}.
1120 Customerid {0,number,0} not found.
1121 You are not view or update information for customerid {0,number,0}.
1122 Customerid {0,number,0} does not have a default shipping address.
1123 You are not allowed to view, update or cancel an order for customerid {0,number,0}.
1124 placed_by_customerid is required to place a new order.
1125 You are not allowed to place a new order. Your administrator can change this.
1126 You are not allowed to update an existing order. Your administrator can change this.
1127 You are not allowed to cancel an order. Your administrator can change this.
1128 export_through may not be before export_from.
1129 No uncanceled orders match the given dates.
1130 The SKU cross reference record is invalid: {0}
Error Field Description
reason The reason that the cross reference record is invalid
1131 There is already a SKU cross reference record for skuid {0,number,0}
Error Field Description
skuid The SKU ID (ours, internal) that already has a cross reference record
1132 There is already a SKU cross reference record for your product ID {0}
Error Field Description
company_product_id Your product ID that already has a cross reference record
1133 There is no SKU cross reference record for skuid {0,number,0}
Error Field Description
skuid The SKU ID (ours, internal) that does not have a cross reference record
1134 There is a SKU cross reference record for skuid {0,number,0} but it does not match company_product_id {1}
Error Field Description
company_product_id The partner's SKU/product ID that does not match
skuid The SKU ID (ours, internal) that has a mismatching a cross reference record
1135 Order detail option {0,number,0} not found.
Error Field Description
optiondefid The order detail option ID (definition) that was not found
1136 Order detail option {0,number,0} ({1}) may not be used for SKU {2,number,0} ({3})
Error Field Description
option_description Description of the order detail option that was specificed
optiondefid The order detail option ID (definition) that was specificed
sku_description The description of the SKU that was specificed
skuid The ID of the SKU that was specified
1137 Could not find applicable pricing for order detail option {0,number,0} ({1}) for SKU {2,number,0} ({3})
Error Field Description
option_description Description of the order detail option that was specificed
optiondefid The order detail option ID (definition) that was specificed
sku_description The description of the SKU that was specificed
skuid The ID of the SKU that was specified

Release Notes

Date Description
2025-12-29 Allow options to be specified for order detail items. See fields details.options on order_place and order_update. See order_detail_option_list for a list of available options.
2024-12-03 Add field shipping_surcharge to all functions that return complete order information, e.g. order_get.
2024-09-28 Zip code may be a US 5 or 9 digit zip code. 99999 or 99999-9999.
2024-08-27 _logid will no longer be included in the API return value.
2024-08-22 Added functions sku_xref_update_product_name, sku_xref_update_upc
2024-08-21 Added parameter additional_emails to order_place and order_update.
2024-08-09 Fixed invalid 1086 error when removing all of a given bird type (e.g. guineas) from an existing order.
2024-08-03 Add functions sku_xref_list, sku_xref_add, sku_xref_update, sku_xref_delete. These functions are operational, but the cross reference data is currently unused. Future projects will take advantage of the cross reference data.
2024-07-13 Added structured error message fields for some error codes. See Error Codes for more infomration.
2024-06-11 Add parameter placed_by_customerid to function order_place.
2024-06-10 Add store_number as output field for order_get.
2024-06-08 Add function customer_set_address.
2024-06-08 Add parameter include_eggs to function availability_get.
2024-06-06 Allow an order cancel for a past or closed ship date if the pack slip is not printed and there are no tracking numbers.
2024-06-04 Add parameter customerid to function order_place
2024-06-03 Bug fix: some special characters, e.g. Á were not being properly encoded on responses from the API.
2024-06-01 Allow a ship date change if thew new ship date is after the original, and is a future date that is not closed. Bypasses errors 1065 and 1077.
2024-05-31 Add parameters include_details and partner_orderid to function order_search
2024-05-30 Bug fix: carry along flag not updated properly in order_update if a ship_date is specified and is the same as the current ship date
2024-05-29 Bug fix: API error when updating an existing order that fails location optimization
2024-05-29 Bug fix: availability check in order_update not using the correct set of order details
2024-05-28 Add packslip_note to output of order_get
2024-05-21 Add provisional parameter to order place. Add functions order_confirm_provisional and order_delete_provisional.
© Copyright 2009–2026 Metzer Farms
Glossary of Terms | Metzer Farms Catalog & Newsletter | Our Privacy Policy | Contact Us | Your IP Address: 216.73.216.29 | © Copyright 2009–2026 Metzer Farms
powered by HatcheryManager.com