Skip to content

Latest commit

 

History

History
43 lines (42 loc) · 1.76 KB

corvid-specific-functions.md

File metadata and controls

43 lines (42 loc) · 1.76 KB

Corvid Function Parameters and Return Object Information

Function Parameters

  • Function name: <create order>
    • If a promise, the reason promise is fulfilled or rejected: <Fulfilled - Order created Rejected - Error message>
      • Parameter Name: <orderInfo>
        • Type: <OrderInfo>
        • Description: <The information for the order being created.>
        • Notes/Limitations: <>
        • Enum <>
        • Required/Optional: <Required>
      • Parameter Name: <orderInfo.cartID>
        • Type: <string>
        • Description: <Shopping cart ID.>
        • Notes/Limitations: <>
        • Enum <>
        • Required/Optional: <Required>
      • Parameter Name: <orderInfo.channelInfo.type>
        • Type: <string>
        • Description: <Sales channel that submitted the order.>
        • Notes/Limitations: <>
        • Enum <"WEB": Wix online store. "POS": Point of sale. "EBAY": eBay. "OTHER_PLATFORM": Order imported from another system (such as Cart2Cart). "WIX_APP_STORE": Order created via the Wix mobile app. >
        • Required/Optional: <Required>

Return Object Parameters

  • Function name: <createorder>
    • Parameter Name: <_id>
      • Type: <string>
      • Description: <Unique order ID>
      • Notes/Limitations: <>
      • Enum: <>
      • Required/Optional: <>
    • Parameter Name: <channelInfo.externalOrderId>
      • Type: <string>
      • Description: <Order ID from an external system (such as eBay or Amazon).>
      • Notes/Limitations: <>
      • Enum: <>
      • Required/Optional: <Optional>
    • Parameter Name: <weightUnit>
      • Type: <string>
      • Description: <The unit in which the order's weight is measured. Either "KG" or "LB". If not provided, the site's default weight unit is used.>
      • Notes/Limitations: <>
      • Enum: <KG, LB>
      • Required/Optional: <Optional>