A unique identifier for the order, which has some meaning to the integrator. This is not the same as the order number assigned by Bay Photo. This will be used to identify a duplicate order in the event that an attempt is made to submit the same order more than once. This should almost certainly always be the integrator's order number, assuming that it is unique across all orders submitted by the integrator.
Must be at least 1 characters long
Must be at most 255 characters long
A flag indicating whether this order is a test order. Integration test orders will be received, validated, and accepted or rejected like real orders, but following those steps, will not be processed for fulfillment. They are viewable like normal orders in the Order API management interface. Integration test orders are not exempt from all of the normal order rules, and must have unique integrator identifiers. An accepted integration test order can be promoted to a real order and enqueued for production using the appropriate button in the management interface.
Time and date at which the order was placed by the customer, in RFC 3339 format (essentially ISO 8601). Must be a time in the past.
An arbitrary reference name or identifier, which has some meaning to the integrator.
Must be at least 1 characters long
Must be at most 255 characters long
Used only by Bay Photo for internal purposes, not by 3rd party integrators. Identifies the actual Bay Photo customer placing the order in contexts where the integration/config itself is not enough to do that.
Must be at least 1 characters long
A recipient email address to which automated notifications should be sent. Example emails would be order confirmations (if applicable) and shipment confirmations. It will not be used for any other purpose, including general customer service communication. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
A code that identifies the shipping method to be used for this order. This code is used by Bay Photo to determine the shipping method to use when fulfilling the order.
Must be at least 1 characters long
Must be at most 255 characters long
A unique identifier or code corresponding to an existing shipping account to be used when billing. May be required or optional depending on account configuration.
Must be at least 1 characters long
Must be at most 255 characters long
A unique identifier or code corresponding to a return address to be used when shipping this order. May be required or optional depending on account configuration.
Must be at least 1 characters long
Must be at most 255 characters long
Strings which are to be included on printed shipping labels
Must contain a minimum of 0 items
Must contain a maximum of 3 items
A configuration object that contains pricing adjustment data to be used when processing the order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
A single unit price value for a product, option, or shipping method, to use when invoicing this order, in integer cents.
Value must be greater or equal to 0
Price adjustment method to send to Labworks (FKA service_type). Only applicable to products/options, not to shipping methods.
"L"
"G"
"M"
"RUSH50"
"METALLIC"
Name of a recipient person or business.
Must be at least 1 characters long
Must be at most 255 characters long
Up to four street address lines.
Must contain a minimum of 1 items
Must contain a maximum of 4 items
Must be at least 1 characters long
Must be at most 255 characters long
City, village, or locality name.
Must be at least 1 characters long
Must be at most 255 characters long
State or region name, which may be a full name or an abbreviation.
Must be at least 1 characters long
Must be at most 255 characters long
Must be at least 1 characters long
Must be at most 64 characters long
Two-character ISO 3166-1 alpha-2 country code
A summary of billing information and amounts for the order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to require it.
Tax total in integer cents.
Value must be greater or equal to 0
Shipping total in integer cents, including discounts.
Value must be greater or equal to 0
Sub-total in integer cents, including discounts.
Value must be greater or equal to 0
Complete total in integer cents, including discounts.
Value must be greater or equal to 0
The name/code of the promo code applied to the order, if any.
Must be at least 1 characters long
Information about a gift certificate used on this order.
The name or code of the gift certificate used.
Must be at least 1 characters long
The amount of the gift certificate used, in integer cents.
Value must be greater or equal to 0
Details about the payment and payment method that was (or will be) used to bill this order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to require it.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
true
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
true
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
true
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
true
A helpful display name for the payment method.
"Apple Pay"
"PayPal"
"Braintree"
"Visa 4321"
True if the order is to be billed on net terms.
True if the order is to be billed using the default payment method on file for the customer.
A unique identifier which indicates which payment method to use when charging this order in a post-paid manner.
A unique identifier for the payment transaction. The name of the payment processor should ideally be included in the 'display_name' property, so that the transaction ID can be used to look up the transaction in the payment processor's system.
A complete list of all images to be used in the order. Property names are arbitrary unique identifiers for each image, and that property name should be used to identify the image in the order wherever it is intended to be used. Property names are limited to 255 characters.
No Additional PropertiesAll properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.{1,255}$
The filename of the image, which may be used to identify images within an order. Not a path - do not include slashes or other path separators.
Must be at least 1 characters long
Must be at most 255 characters long
The full URL of the image, exactly as it should be used when the image is being retrieved during order processing. The image's accessibility may be evaluated upon order submission, and as a result it is strongly recommended to ensure the provided URL accepts HEAD requests (which will save bandwidth), and that the URL is usable/accessible before submitting the order.
Must be at least 1 characters long
Must be at most 8192 characters long
A URL to a thumbnail-sized copy of the image. Preferably, thumbnails should be kept to a maximum of 400 pixels on the longest side. This thumbnail is optional. A thumbnail will be generated internally if not provided, so providing a thumbnail will decrease the wait time for order acceptance. As with full-size image URLs, is strongly recommended to ensure the provided URL usable/accessible before submitting the order.
Must be at least 1 characters long
Must be at most 8192 characters long
Must contain a minimum of 1 items
An optional product name, which may be used to visually identify the product within the order JSON. Including a value here will be helpful to both the integrator and Bay Photo when it comes to identifying products quickly.
The code that identifies the product being ordered.
Must be at least 1 characters long
Must be at most 255 characters long
An unique identifier for the exact instance of this product, as it exists in this order, which has some meaning to the integrator. This is NOT the same as a product code or SKU - the same product ordered multiple times in the same order, or across multiple orders, should have different internal identifiers. Intended to help an integrator link their internal order data with order data after submission.
Must be at least 1 characters long
Must be at most 255 characters long
Value must be greater or equal to 1
Some integrators may have a catalog setup which contains 'custom size' products, which do not have a fixed size, and must have their size specified in the order. Including a custom sized product in an order without a size will cause the order to be rejected.
Product width in inches
Value must be greater or equal to 0 and a multiple of 0.25
Product height in inches
Value must be greater or equal to 0 and a multiple of 0.25
Number of degrees to rotate the entire product for right-reading display or rendering, clockwise. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it. Typically used to correct for the purely-visual rotation of certain products in a user-displayed view, when the natural orientation of a product is different from the way it is shown to the user. This can impact crop values.
Value must be greater or equal to 0
"Job text" to be passed directly into DP2 when rendering this product for print. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Must be at least 1 characters long
Strings to be printed on the back side of the product. Only supported by a small subset of products, like photo prints. Limited to 2 lines of 30 characters each.
Must contain a minimum of 0 items
Must contain a maximum of 2 items
Must be at least 1 characters long
Must be at most 30 characters long
A summary of billing information and amounts for A SINGLE QUANTITY of this product. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to require it.
Single-quantity price, without discounts, in integer cents.
Value must be greater or equal to 0
Single-quantity discount amount, in integer cents.
Value must be greater or equal to 0
The literal discount code or promo code applied.
"METALLUV"
"SUPER20"
Displayable 'name' of the discount, usually helpful because the code itself is not helpful in understanding what the true meaning of the discount is.
"10%"
"7.5%"
A list of product-level options associated with the product. Depending on the product, one or more options may be required to be specified.
No Additional ItemsAn optional option name, which may be used to visually identify the option within the order JSON. Including a value here will be helpful to both the integrator and Bay Photo when it comes to identifying options quickly.
The code that identifies the option being ordered.
Must be at least 1 characters long
Must be at most 255 characters long
Value must be greater or equal to 1
Some integrators may have a catalog setup which contains 'custom size' options, which do not have a fixed size, and must have their size specified in the order, either for pricing or production reasons. Including a custom sized option in an order without a size will cause the order to be rejected.
Option width in inches
Value must be greater or equal to 0 and a multiple of 0.25
Option height in inches
Value must be greater or equal to 0 and a multiple of 0.25
Options may occasionally require some text content to be specified, i.e. imprinting text.
Must be at most 256 characters long
A summary of billing information and amounts for A SINGLE QUANTITY of this option. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to require it.
Single-quantity price, without discounts, in integer cents.
Value must be greater or equal to 0
Single-quantity discount amount, in integer cents.
Value must be greater or equal to 0
The literal discount code or promo code applied.
"METALLUV"
"SUPER20"
Displayable 'name' of the discount, usually helpful because the code itself is not helpful in understanding what the true meaning of the discount is.
"10%"
"7.5%"
A configuration object that contains pricing adjustment data to be used when processing the order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Same definition as pricing_configurationA map between image node IDs and information about what image to apply, and how to apply it.
No Additional PropertiesAll properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[0-9]+$
The unique identifier for the image to be associated with the specified image node. This identifier is determined by the integrator and can be found in the top-level images section of the order JSON document. An image can (and should) be reused across multiple products in the same order, if necessary.
"Job text" to be passed directly into DP2 when rendering this image in the product layout for print. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Must be at least 1 characters long
An optional image filter/LUT to apply to the image for this product. Only to be provided if specifically allowed by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Crop information as it relates to the specified image being placed in the specified image node. Cropping is not available to integrators by default. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it. We strongly recommend against using cropping due to its inherent complexity. Provide images which have already been correctly sized for the product being ordered.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"C"
The distance from the left edge of the node to the center of the uncropped image, wherein the magnitude of the number indicates a percentage of the width of the uncropped image, and the sign of the number indicates on which side of the left edge of the node the center of the uncropped image lies. Positive numbers indicate that the center of the image lies to the right of the left edge of the node. Negative numbers indicate that the center of the image lies to the left of the left edge of the node.
Value must be strictly greater than 0 and strictly lesser than 100
The distance from the top edge of the node to the center of the uncropped image, wherein the magnitude of the number indicates a percentage of the height of the uncropped image, and the sign of the number indicates on which side of the top edge of the node the center of the uncropped image lies. Positive numbers indicate that the center of the image lies below the top edge of the node. Negative numbers indicate that the center of the image lies above the top edge of the node.
Value must be strictly greater than 0 and strictly lesser than 100
Width of the crop area, given as a percentage of the full image's width
Value must be strictly greater than 0 and lesser or equal to 100
Height of the crop area, given as a percentage of the full image's height
Value must be strictly greater than 0 and lesser or equal to 100
Rotation of the node image in degrees, clockwise
Value must be greater or equal to 0
The crop type/method to be used.
A configuration object that contains pricing adjustment data to be used when processing the order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Same definition as pricing_configurationA list of order-level options, not associated with any particular product.
No Additional ItemsAn optional option name, which may be used to visually identify the option within the order JSON. Including a value here will be helpful to both the integrator and Bay Photo when it comes to identifying options quickly.
The code that identifies the option being ordered.
Must be at least 1 characters long
Must be at most 255 characters long
The quantity of this order option to be included in the order. In the case of options that are understood to apply to images themselves, like color correction, the quantity should be set to 1 - our system will automatically determine the appropriate billing quantity based on the number of images in the order. Ask your account manager for more details.
Value must be greater or equal to 1
Options may occasionally require some text content to be specified, i.e. imprinting text.
Must be at most 256 characters long
A summary of billing information and amounts for A SINGLE QUANTITY of this order option. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to require it.
Single-quantity price, without discounts, in integer cents.
Value must be greater or equal to 0
Single-quantity discount amount, in integer cents.
Value must be greater or equal to 0
The literal discount code or promo code applied.
"METALLUV"
"SUPER20"
Displayable 'name' of the discount, usually helpful because the code itself is not helpful in understanding what the true meaning of the discount is.
"10%"
"7.5%"
A configuration object that contains pricing adjustment data to be used when processing the order. Only to be provided if specifically requested by Bay Photo. Including this JSON property will cause orders to be rejected if the integration is not configured to allow it.
Same definition as pricing_configuration