Get draft order
Retrieves a draft order by the id returned from POST /draft-orders, with the options, pricing, and availability that draft resolved.
The body is the one POST /draft-orders returns, so a caller that drafts, reads the draft back, then places it with POST /draft-orders/{id}/order handles a single shape. The draft is returned as it was resolved: nothing is repriced on read, so a draft can describe availability or pricing that has since changed, and placing it can still be rejected.
A draft that does not exist and a draft belonging to another organization both return 404, so the endpoint cannot be used to discover which draft ids exist.
/{id}AuthorizationBearer token · headerrequiredAPI token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.
read:draft-ordersidstringrequiredThe draft order was found.
idstringrequiredThe unique identifier for the draft order.
createdAtstringrequiredsupplierstringrequiredaddressOrderPropertyAddressrequiredShow propertiesHide properties
line1stringrequiredline2string | nullrequiredcitystringrequiredstateOrProvincestringrequiredpostalCodestringrequiredcountrystring | nullrequiredcontactInfoobject | nullrequiredShow propertiesHide properties
firstNamestring | nullrequiredlastNamestring | nullrequiredemailstringrequiredphonestring | nullrequiredpoNumberstring | nullrequiredspecialInstructionsstring | nullrequiredlineItemsDraftOrderLineItem[]requiredThe priced line items, with the options, addons, warranties, and availability resolved for each.
Show propertiesHide properties
DraftOrderLineItemskustringrequirednamestringrequiredsubtitlestring | nullrequiredimageUrlstringrequiredquantityintegerrequiredunitOfMeasurestringrequiredquantityPerBaseUnitnumberrequiredThe number of baseUnitOfMeasure contained in each unitOfMeasure. Multiply by quantity for the total in the base unit.
baseUnitOfMeasurestringrequiredpriceCentsintegerrequiredPrice in cents per base unit.
availabilityStatusstringrequiredAvailability of the product in the draft's distribution center.
IN_STOCKOUT_OF_STOCKSUBSTITUTION_ONLYUNAVAILABLEUNKNOWNoptionsDraftOrderLineItemOption[]requiredThe options selected on this line.
Show propertiesHide properties
DraftOrderLineItemOptionkeystringrequiredThe option identifier.
valuestringrequiredThe selected value identifier.
namestringrequiredHuman readable name of the value.
hexstring | nullrequiredCSS hex color of the value, for values that represent a color. Null when it has none.
attributesDraftOrderLineItemAttribute[]requiredCatalog attributes of this product relevant to ordering it. Empty when it has none.
Show propertiesHide properties
DraftOrderLineItemAttributenamestringrequiredvaluestringrequiredaddonsDraftOrderAddon[]requiredThe addons attached to this line.
Show propertiesHide properties
DraftOrderAddonidstringrequiredPass this as an addonIds entry to attach the addon.
titlestringrequiredpriceCentsintegerrequiredavailableAddonsDraftOrderAddon[]requiredAddons that can be attached to this line.
Show propertiesHide properties
DraftOrderAddonidstringrequiredPass this as an addonIds entry to attach the addon.
titlestringrequiredpriceCentsintegerrequiredavailableWarrantiesDraftOrderWarranty[]requiredWarranties that can be purchased alongside this line.
Show propertiesHide properties
DraftOrderWarrantyskustringrequiredPass this as warrantySku on the line item to attach the warranty.
namestringrequireddescriptionstring | nullrequiredmanufacturerstringrequiredpriceCentsintegerrequiredselectedWarrantyobjectrequiredShow propertiesHide properties
skustringrequiredPass this as warrantySku on the line item to attach the warranty.
namestringrequireddescriptionstring | nullrequiredmanufacturerstringrequiredpriceCentsintegerrequireddistributionCenterDraftOrderDistributionCenterrequiredThe distribution center the order would be fulfilled from.
Show propertiesHide properties
idstringrequirednamestringrequiredstoreNumberstringrequiredMay not actually be numeric.
phonestring | nullrequiredThe distribution center's phone number as the distributor publishes it. Null when not provided.
addressOrderPropertyAddressrequiredShow propertiesHide properties
line1stringrequiredline2string | nullrequiredcitystringrequiredstateOrProvincestringrequiredpostalCodestringrequiredcountrystring | nullrequiredfulfillmentMethodDraftOrderFulfillmentMethodrequiredThe fulfillment method resolved for this draft.
Show propertiesHide properties
idstringrequiredtitlestringrequireddescriptionstring | nullrequiredtypestringrequiredDELIVERYPICKUPavailableDatesstring[]requiredThe dates this method can fulfill on. Pass one as requestedDeliveryDate when placing the order.
availableFulfillmentMethodsDraftOrderFulfillmentMethod[]requiredEvery fulfillment method available for this order, with the dates each can fulfill on.
Show propertiesHide properties
DraftOrderFulfillmentMethodidstringrequiredtitlestringrequireddescriptionstring | nullrequiredtypestringrequiredDELIVERYPICKUPavailableDatesstring[]requiredThe dates this method can fulfill on. Pass one as requestedDeliveryDate when placing the order.
requestedDeliveryDatestringrequiredpaymentMethodIdstringrequiredThe payment method resolved for this draft.
availablePaymentMethodsDraftOrderPaymentMethod[]requiredEvery payment method available to this caller for this order.
Show propertiesHide properties
DraftOrderPaymentMethodidstringrequiredPass this as paymentMethodId when placing the order.
typestringrequiredMANUFACTURER_CREDITSTRIPEdescriptionstringrequiredlast4string | nullrequiredThe saved card's last four digits. Null for non-card methods.
pricingDraftOrderPricingrequiredShow propertiesHide properties
subtotalCentsintegerrequiredtaxCentsintegerrequiredtotalPriceCentsintegerrequiredSubtotal plus tax and fees, less discounts.
feesobject[]requiredShow propertiesHide properties
objectnamestringrequiredamountCentsintegerrequireddiscountsobject[]requiredShow propertiesHide properties
objectnamestringrequiredamountCentsintegerrequiredsubscribersobject[]requiredShow propertiesHide properties
objectemailstringrequiredBad request - Invalid input data
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
objectfieldstringrequirederrorstringrequiredUnauthorized - Missing or invalid authentication
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
objectfieldstringrequirederrorstringrequiredForbidden - The token is missing the scope this operation requires, or was minted for the other environment
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
objectfieldstringrequirederrorstringrequiredNot found - no draft order with this id is visible to the caller
codestringrequiredError code indicating the type of error
DRAFT_ORDER_NOT_FOUNDmessagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
objectfieldstringrequirederrorstringrequiredInternal server error
codestringrequiredError code indicating the type of error
messagestringrequiredHuman-readable error message explaining what went wrong
detailsobject[]Detailed validation errors when applicable
Show propertiesHide properties
objectfieldstringrequirederrorstringrequired