Models

order rapiorder response for "get /order" api call merchant order ref str order number str email str purchased at datetime fulfilled at datetime (optional) payment method str is giftcard used bool delivery info rapideliveryinfo (optional) line items list of models docid 82ltwhnmvb0tu1yenec80 rapiorderlineitem line item for "get /order" api call line item ref str title str variant str (optional) price models /#rapiamount tax detail models /#rapilineitemtaxdetail (optional) quantity int returnable quantity int discount models /#rapiamount (optional) image url str weight in kilograms float product ref str variant ref str (optional) sku str (optional) categories list of str non returnable reasons list of str rapideliveryinfo delivery address and tracking label address models /#rapiaddress tracking models /#rapitracking return rapireturn response for "get /refund" api call merchant rma ref str created at datetime line items list of models docid 82ltwhnmvb0tu1yenec80 return shipping models docid 82ltwhnmvb0tu1yenec80 (optional) rapireturnlineitem line item for "get /refund" api call merchant order ref str line item ref str price models /#rapiamount tax detail models /#rapilineitemtaxdetail (optional) quantity int return reason str child return reason str (optional) adjustments list of models docid 82ltwhnmvb0tu1yenec80 compensation method models docid 82ltwhnmvb0tu1yenec80 rapireturnshipping return shipping specification from address models /#rapiaddress (optional) to address models /#rapiaddress (optional) tracking models /#rapitracking (optional) deductions models /#rapiamount (optional) rapireturnadjustment adjustment for "get /refund" api call adjustment models /#rapiamount description str (optional) rapicompensationmethod compensation method for "get /refund" api call values refund, exchange, credit refundid order rapirefundidorder response body for "post /refundid" api call refundid id str merchant rma ref str (optional) status models docid 82ltwhnmvb0tu1yenec80 line items list of models docid 82ltwhnmvb0tu1yenec80 refund breakdown models docid 82ltwhnmvb0tu1yenec80 shipping label models /#rapishippinglabel (optional) reconciliation breakdown models docid 82ltwhnmvb0tu1yenec80 (optional) rapicloselineitem request model for "post /close refunds" api call merchant order ref str line item ref str quantity int resolution models docid 82ltwhnmvb0tu1yenec80 restock bool notes str (optional) rapicloserefundidorder request model for "post /close refunds" api call refundid id str merchant rma ref str (optional) line items list of models docid 82ltwhnmvb0tu1yenec80 rapirefundidorderstatus event which triggered the "post /refundid" api call values refunding, refundid, closed, failed rapirefundidbreakdown breakdown of the refund amount for "post /refundid" api call subtotal models /#rapiamount store return fee models /#rapiamount customer shipping cost models /#rapiamount total models /#rapiamount rapireconciliationbreakdown breakdown of the reconciliation amount for close refund action discounted amount to reconcile from merchant float amount to reconcile from merchant float shipping to reconcile from merchant float refundid cut float merchant advance adjustment float discounted refundid cut float invoice created at datetime (optional) closed by closedby closed on datetime rapirefundidresolution a resolution code used in the rapirefundidorderlineitem values accept accept the item reject used item reject due to the item being used reject sale item reject an item that was on sale reject damaged item reject an item that arrived damaged reject empty package reject as the package was empty reject not received reject as the item was not received reject incorrect item reject an item that was incorrect reject no tracking reject due to lack of tracking reject dishonest reject due to dishonesty reject policy violation reject due to a policy violation reject other reason reject for other unspecified reasons cancelled by customer cancelled by the customer cancelled by merchant cancelled by the merchant cancelled by refundid cancelled by refundid rejected by refundid item not shipped rejected because the item was not shipped rejected by refundid other reason rejected by refundid for another unspecified reason double refund double refund rapireturnreasonnote title str value str rapirefundidorderlineitem a line item for "post /refundid" api call merchant order ref str line item ref str quantity int return reason str child return reason str (optional) return reason notes list of models docid 82ltwhnmvb0tu1yenec80 resolution models docid 82ltwhnmvb0tu1yenec80 (optional) restock bool (default false) notes str (optional) rapirefundidordertracking item for "post /tracking" api call refundid id str tracking models /#rapitracking standard return rapiclosestandardreturn request model for "post /close refunds" api call attributes standard return id str merchant rma ref str (optional) line items list of models docid 82ltwhnmvb0tu1yenec80 rapistandardreturnstatus enumeration representing the possible statuses for a standard return values lodging the return is currently being lodged lodged the return has been successfully lodged closing the return process is in the closing stages closed the return process has been completed and closed rapistandardreturnclosebreakdownrefund attributes refund method ref str a unique identifier for the refund method amount models /#rapiamount rapistandardreturnclosebreakdown attributes final refund amount models /#rapiamount refunds rapistandardrefundclosebreakdownrefund a list of tthe refunds to the order only non zero refunds are recorded closed on datetime closed by closedby rapistandardreturn model representing a standard return attributes standard return id str a unique identifier for the standard return return resolution str the resolution of the return status rapistandardreturnstatus the current status of the return requested refund breakdown rapirefundidbreakdown detailed breakdown of the requested refund line items list of rapirefundidorderlineitem details the items involved in the return shipping label rapishippinglabel (optional) shipping label for the return, if available close breakdown rapistandardreturnclosebreakdown (optional) the close breakdown if the standard return is closed exchange models /#rapiexchange (optional) the exchange order purchase request information if the return is an exchange rapistandardrmatracking model for tracking standard rma (return merchandise authorization) important note do not modify this class as it is crucial for maintaining the integrity of the documentation any changes could impact the accuracy of the api documentation attributes standard rma id str unique identifier for the standard rma tracking rapitracking tracking details for the rma common rapiamount canonical monetary amount specification amount float currency iso 4217 code rapilineitemtaxdetail tax breakdown for a line item if no tax amount is provided tax included must be true tax rapiamount (optional) tax included bool rapiaddress canonical address specification address1 str address2 str (optional) city str zip str (optional) province str (optional) country str country code str (optional) rapitracking tracking label, with carrier specification carrier str tracking number str status refundidtrackingstatus (optional) status date datetime (optional) rapishippinglabel a shipping label for a refundid rma for "post /refundid" api call tracking models /#rapitracking purchase price models /#rapiamount (optional) label url str (optional) refundidtrackingstatus enumeration representing the possible tracking statuses for shipments values not shipped yet the item has not been shipped yet transit the item is currently in transit delivered the item has been successfully delivered failure there was a failure in delivering the item unknown the tracking status of the item is unknown rapiexchangeitem a line item which has been requested to be purchased within a purchase request ( models /#rapiexchange ) item ref str quantity int the quantity requested to be purchased of this item expected price models /#rapiamount the expected price of the line item in the exchange order sku str (optional) refunded line item ref str (optional) the line item ref of the related models /#rapirefundidorderlineitem if this purchase request line item was directly exchanged for one of the rapirefundidorderlineitem in the return rapiexchangestatus enumeration representing the status of an exchange values ready the exchange is ready to be placed purchasing the exchange is in process of completing automated purchase purchased the exchange order is purchased voided the exchange order has been voided rapiexchange information about a purchase request for an exchange purchase request id int the id of the exchange request in refundid status models /#rapiexchangestatus the status of the exchange expected shipping price models /#rapiamount the expected price of the exchange order's outbound shipping fname str lname str email str phone str shipping address models /#rapiaddress line items list of models /#rapiexchangeitem draft order ref str (optional) the id of the draft order created in the ecommercre platform (if one was created) shipping rate ref str (optional) shipping rate title str (optional) order name str (optional) the name of the created order in the ecommerce platform, if one was created can only be populated once the exchange is purchased order ref str (optional) the id of the created order in the ecommerce platform, if one was created can only be populated once the exchange is purchased rapireturnnote one of standard return id or refundid id must be provided standard return id str (optional) refundid id str (optional) note str rapireturnflag one of standard return id or refundid id must be provided standard return id str (optional) refundid id str (optional) is flagged str datetime iso 8601 format