Copy an order on hold
/v1/organizations/{orgId}/orders/{orderId}/copiesAuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
orgIdstringrequiredorderIdstringrequiredapplication/jsoncustomerLabelstring | nullShow propertiesHide properties
stringnullorderKeystringrequiredorderNumberstringrequiredstoreLinkIdstringstoreRefstringsubmissionKeystringrequiredSuccess
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredorderobjectrequiredShow propertiesHide properties
customerLabelstring | nullrequiredidstringrequiredkindstringrequiredordinaryredemptionreshipship_backreceiptobjectrequiredShow propertiesHide properties
operationIdstring | nullrequiredrecordedAtstringrequiredvisibleOrderNumberstring | nullrequiredcancellationobject | nullShow propertiesHide properties
deadlineAtstring<date-time>requiredeligiblebooleanrequirednullcurrentobject | nullrequiredShow propertiesHide properties
insuranceobject | nullShow propertiesHide properties
insuredbooleanrequiredWhether the order asks the warehouse to insure its one parcel. False is the explicit no-additional-insurance choice.
insuredValueobject | nullrequiredDeclared value to insure, independent of goods and customs values. Null when not insured.
Show propertiesHide properties
amountstringrequiredcurrencystringrequirednulllabelobject | nullrequiredNull until the warehouse buys the one label for this order, or when the order has more than one active shipment.
Show propertiesHide properties
insuredboolean | nullrequiredWhether the warehouse's label reports additional coverage. Null when the label does not report it.
insuredValueobject | nullrequiredShow propertiesHide properties
amountstringrequiredcurrencystringrequirednullproviderstring | nullrequiredShow propertiesHide properties
stringnullnullproviderstring | nullrequiredCoverage provider. carrier is the carrier's declared-value coverage.
Show propertiesHide properties
stringnullnullrequestedDeliveryConfirmationstring | nullShow propertiesHide properties
stringnullorderDatestring | nullrequiredproviderOrderNumberstring | nullrequiredrecipientNamestring | nullrequiredstatusstringrequiredon_holdreadyshippedcanceledunknowntrackingobject[]requiredShow propertiesHide properties
objectdeliveryConfirmationstring | nullShow propertiesHide properties
stringnullcarrierstring | nullrequirednumberstringrequiredshipDatestring | nullrequiredparcelEvidenceobjectShow propertiesHide properties
allParcelsCollectedboolean | nullrequiredcoveragestringrequiredcompleteincompletemembershipObservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullstatestringrequiredconfirmedpendingincompletestaleunavailableunknownparcelsobject[]requiredShow propertiesHide properties
objectidstringrequiredcarrierstring | nullrequirednumberstringrequiredstatestringrequiredconfirmedpendingunavailableunknowneventobject | nullrequiredShow propertiesHide properties
detailCodestringrequiredoccurredAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullreportedAtstring | nullrequirednulldetailCodestring | nullrequiredobservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullestablishedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullrefreshstringrequiredcurrentunavailableunknownstalesimulatedbooleanrequiredcustomerNotesstring | nullrequiredholdUntilDatestring | nullrequireditemsobject[]requiredShow propertiesHide properties
objectdeclaredUnitValuestring | nullnamestring | nullrequiredproductIdstring | nullquantityinteger | nullrequiredShow propertiesHide properties
integernullskustring | nullrequiredunitPricestring | nullrecipientobject | nullrequiredShow propertiesHide properties
citystring | nullrequiredcompanystring | nullrequiredcountrystring | nullrequiredemailstring | nullrequirednamestring | nullrequiredphonestring | nullrequiredpostalCodestring | nullrequiredstatestring | nullrequiredstreet1string | nullrequiredstreet2string | nullrequirednullrevisionstringrequiredrequestedShippingServicestring | nullrequirednullpackingExceptionobject | nullRedemption cards held while packing, each with its offer, response deadline and outcome. Null when no card was held.
Show propertiesHide properties
estimateobject | nullrequiredShow propertiesHide properties
amountstring | nullrequiredEstimated total in currency units. Null when a component is not yet known; unknown is never reported as zero.
asOfstring<date-time>requiredbasisstringrequiredcompletebooleanrequiredTrue only when every affected unit is applied and the amount is known. False while any unit is not applied, because that card is priced as ordered, and when the amount is null.
componentsobject[]requiredShow propertiesHide properties
objectamountstring | nullrequiredcodestringrequiredcurrencystringrequiredrevisionintegerrequirednullidstringrequiredrecordedAtstring<date-time>requiredresolvedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullrevisionintegerrequiredstatusstringrequiredheld keeps the order from shipping until every unit settles.
heldresolvedunitsobject[]requiredShow propertiesHide properties
objectdecisionobject | nullrequiredShow propertiesHide properties
answerstringrequiredaccept_offerremove_carddecidedAtstring<date-time>requiredofferRevisionintegerrequiredoperationIdstring | nullrequiredOperation ID of the answer that made this decision. Retry or recover an answer by this ID. Null when the warehouse or the deadline decided.
sourcestringrequiredanswer is the customer's own answer; warehouse is a decision the warehouse recorded on the customer's instruction; deadline_default removes the card when the response window closes without one.
answerwarehousedeadline_defaultnullfoundConditionstring | nullrequiredShow propertiesHide properties
stringnullidstringrequiredlineIndexintegerrequiredofferobjectrequiredShow propertiesHide properties
conditionstring | nullrequiredCondition of the offered replacement card, when graded.
Show propertiesHide properties
stringnullidstringrequiredkindstringrequiredreplacement offers one reserved card; no_offer means the only choice is removing the card.
replacementno_offerproductstring | nullrequiredThe SKU of the offered replacement card, or null for no_offer.
readableAtstring<date-time>requiredresponseDeadlineAtstring<date-time>requiredrevisionintegerrequiredorderedobjectrequiredShow propertiesHide properties
conditionstring | nullrequiredShow propertiesHide properties
stringnullproductstringrequiredskustring | nullrequiredoutcomestringrequiredawaiting_answerreceivedpendingappliedrefusedpackCardOrdinalinteger | nullrequiredShow propertiesHide properties
integernullreasonstringrequiredcondition_mismatchmissingdamagedresponseDeadlineAtstring<date-time>requiredunitIndexintegerrequirednullsourceOrderIdstring | nullrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequiredError
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired