Lambda Store API Documentation

This article lists Lambda Store API requests and responses.

 

important-3 NOTE

This article assumes that you have some knowledge in using APIs. If you would like a brief explanation of using APIs, click here for an introductory article.


TOPICS


Customers

Customers

This request creates a "customer" account in the Lambda Store.

Schema (Application/JSON):

  • customer (Required): Customer Object
  • password: String
  • redirectUrl: String
POST /V1/customers

Sample:
{
 "customer": {
             "id": 0,
             "group_id": 0,
             "default_billing": "string",
             "default_shipping": "string",
             "confirmation": "string",
             "created_at": "string",
             "updated_at": "string",
             "created_in": "string",
             "dob": "string",
             "email": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "prefix": "string",
             "suffix": "string",
             "gender": 0,
             "store_id": 0,
             "taxvat": "string",
             "website_id": 0,
             "addresses": [
             {
             "id": 0,
             "customer_id": 0,
             "region": {
             "region_code": "string",
             "region": "string",
             "region_id": 0,
             "extension_attributes": {}
             },
             "region_id": 0,
             "country_id": "string",
             "street": [
             "string"
             ],
             "company": "string",
             "telephone": "string",
             "fax": "string",
             "postcode": "string",
             "city": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "prefix": "string",
             "suffix": "string",
             "vat_id": "string",
             "default_shipping": true,
             "default_billing": true,
             "extension_attributes": {},
             "custom_attributes": [
             {
             "attribute_code": "string",
             "value": "string"
             }
             ]
             }
             ],
             "disable_auto_group_change": 0,
             "extension_attributes": {
             "company_attributes": {
             "customer_id": 0,
             "company_id": 0,
             "job_title": "string",
             "status": 0,
             "telephone": "string",
             "extension_attributes": {}
             },
             "is_subscribed": true,
             "amazon_id": "string",
             "vertex_customer_code": "string"
             },
             "custom_attributes": [
             {
             "attribute_code": "string",
             "value": "string"
             }
             ]
 },
 "password": "string",
 "redirectUrl": "string"
}

Back to TOPICS

Customers/Addresses/{AddressID}

This request retrieves customer address in the Lambda Store.

Schema (Application/JSON):

  • addressId (required): Integer
GET /V1/customers/addresses/{addressId}

Back to TOPICS

Customers/isEmailAvailable

This request checks if a given email is associated with a customer account in a given website in the Lambda Store.

Schema (Application/JSON):

  • customerEmail (required): String
  • websiteId: Integer
POST /V1/customers/isEmailAvailable

Sample:
{
 "customerEmail": "string",
 "websiteId": 0
}

Back to TOPICS

Customers/Me (Update)

This request updates a customer in the Lambda Store.

Schema (Application/JSON):

  • customer (Required): Customer Object
  • passwordHash: String
PUT /V1/customers/me

Sample:

"customer": {
             "id": 0,
             "group_id": 0,
             "default_billing": "string",
             "default_shipping": "string",
             "confirmation": "string",
             "created_at": "string",
             "updated_at": "string",
             "created_in": "string",
             "dob": "string",
             "email": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "prefix": "string",
             "suffix": "string",
             "gender": 0,
             "store_id": 0,
             "taxvat": "string",
             "website_id": 0,
             "addresses": [
             {
             "id": 0,
             "customer_id": 0,
             "region": {
             "region_code": "string",
             "region": "string",
             "region_id": 0,
             "extension_attributes": {}
             },
             "region_id": 0,
             "country_id": "string",
             "street": [
             "string"
             ],
             "company": "string",
             "telephone": "string",
             "fax": "string",
             "postcode": "string",
             "city": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "prefix": "string",
             "suffix": "string",
             "vat_id": "string",
             "default_shipping": true,
             "default_billing": true,
             "extension_attributes": {},
             "custom_attributes": [
             {
             "attribute_code": "string",
             "value": "string"
             }
             ]
             }
             ],
             "disable_auto_group_change": 0,
             "extension_attributes": {
             "company_attributes": {
             "customer_id": 0,
             "company_id": 0,
             "job_title": "string",
             "status": 0,
             "telephone": "string",
             "extension_attributes": {}
             },
             "is_subscribed": true,
             "amazon_id": "string",
             "vertex_customer_code": "string"
             },
             "custom_attributes": [
             {
             "attribute_code": "string",
             "value": "string"
             }
             ]
 },
 "passwordHash": "string"
}

Back to TOPICS

Customers/Me (Retrieve)

This request gets a customer by Customer ID in the Lambda Store.

Schema (Application/JSON):

  • id (Required): Integer
GET /V1/customers/me

Back to TOPICS

Customers/Password

This request sends an email to the customer with a password reset link in the Lambda Store.

Schema (Apllication/JSON):

  • email (Required): String
  • template: String
  • websiteId: String
PUT /V1/customers/password

Sample:
{
 "email": "string",
 "template": "string",
 "websiteId": 0
}

Back to TOPICS

Customer/{customerId} (Retrieve)

This request gets a customer by Customer ID in the Lambda Store.

Schema (Application/JSON):

  • customerId: integer
GET /V1/custoemrs/{customerId}

Back to TOPICS

Customer/{customerId} (Update)

This request updates a customer by Customer ID in the Lambda Store.

Schema (Application/JSON):

  • customerId: integer
GET /V1/customers/{customerId}

Sample:
{
 "customer": {
   "id": 0,
   "group_id": 0,
   "default_billing": "string",
   "default_shipping": "string",
   "confirmation": "string",
   "created_at": "string",
   "updated_at": "string",
   "created_in": "string",
   "dob": "string",
   "email": "string",
   "firstname": "string",
   "lastname": "string",
   "middlename": "string",
   "prefix": "string",
   "suffix": "string",
   "gender": 0,
   "store_id": 0,
   "taxvat": "string",
   "website_id": 0,
   "addresses": [
     {
       "id": 0,
       "customer_id": 0,
       "region": {
         "region_code": "string",
         "region": "string",
         "region_id": 0,
         "extension_attributes": {}
       },
       "region_id": 0,
       "country_id": "string",
       "street": [
         "string"
       ],
       "company": "string",
       "telephone": "string",
       "fax": "string",
       "postcode": "string",
       "city": "string",
       "firstname": "string",
       "lastname": "string",
       "middlename": "string",
       "prefix": "string",
       "suffix": "string",
       "vat_id": "string",
       "default_shipping": true,
       "default_billing": true,
       "extension_attributes": {},
       "custom_attributes": [
         {
           "attribute_code": "string",
           "value": "string"
         }
       ]
     }
   ],
   "disable_auto_group_change": 0,
   "extension_attributes": {
     "company_attributes": {
       "customer_id": 0,
       "company_id": 0,
       "job_title": "string",
       "status": 0,
       "telephone": "string",
       "extension_attributes": {}
     },
     "is_subscribed": true,
     "amazon_id": "string",
     "vertex_customer_code": "string"
   },
   "custom_attributes": [
     {
       "attribute_code": "string",
       "value": "string"
     }
   ]
 },
 "passwordHash": "string"
}

Back to TOPICS


Directory

Directory/Countries

This request gets country and region information for the Lambda Store.

GET /V1/directory/countries

Back to TOPICS

Directory/Countries/{countryId}

This request gets country and region information by Country ID for the Lambda Store.

Schema (Application/JSON):

  • countryId (Required): String
GET /V1/directory/countries/{countryId}

Back to TOPICS


Orders

Orders (Retrieve)

This request lists orders that match specified search criteria in the Lambda Store.

Schema (Application/JSON):

searchCriteria[currentPage] Integer Current Page
searchCriteria[filterGroups][0][filters][0][conditionType] String Condition Type
searchCriteria[filterGroups][0][filters][0][field] String Field
searchCriteria[filterGroups][0][value] String Value
searchCriteria[pageSize] Integer Page Size
searchCriteria[sortOrders][0][direction] String Sorting Direction
searchCriteria[sortOrders][0][field] String Sorting Field
GET /V1/orders

Back to TOPICS

Orders/Create

This request creates an order in the Lambda Store.

Schema (Application/JSON):

  • order (Required): Order Object
PUT /V1/orders/create

Sample:
{
 "entity": {
             "adjustment_negative": 0,
             "adjustment_positive": 0,
             "applied_rule_ids": "string",
             "base_adjustment_negative": 0,
             "base_adjustment_positive": 0,
             "base_currency_code": "string",
             "base_discount_amount": 0,
             "base_discount_canceled": 0,
             "base_discount_invoiced": 0,
             "base_discount_refunded": 0,
             "base_grand_total": 0,
             "base_discount_tax_compensation_amount": 0,
             "base_discount_tax_compensation_invoiced": 0,
             "base_discount_tax_compensation_refunded": 0,
             "base_shipping_amount": 0,
             "base_shipping_canceled": 0,
             "base_shipping_discount_amount": 0,
             "base_shipping_discount_tax_compensation_amnt": 0,
             "base_shipping_incl_tax": 0,
             "base_shipping_invoiced": 0,
             "base_shipping_refunded": 0,
             "base_shipping_tax_amount": 0,
             "base_shipping_tax_refunded": 0,
             "base_subtotal": 0,
             "base_subtotal_canceled": 0,
             "base_subtotal_incl_tax": 0,
             "base_subtotal_invoiced": 0,
             "base_subtotal_refunded": 0,
             "base_tax_amount": 0,
             "base_tax_canceled": 0,
             "base_tax_invoiced": 0,
             "base_tax_refunded": 0,
             "base_total_canceled": 0,
             "base_total_due": 0,
             "base_total_invoiced": 0,
             "base_total_invoiced_cost": 0,
             "base_total_offline_refunded": 0,
             "base_total_online_refunded": 0,
             "base_total_paid": 0,
             "base_total_qty_ordered": 0,
             "base_total_refunded": 0,
             "base_to_global_rate": 0,
             "base_to_order_rate": 0,
             "billing_address_id": 0,
             "can_ship_partially": 0,
             "can_ship_partially_item": 0,
             "coupon_code": "string",
             "created_at": "string",
             "customer_dob": "string",
             "customer_email": "string",
             "customer_firstname": "string",
             "customer_gender": 0,
             "customer_group_id": 0,
             "customer_id": 0,
             "customer_is_guest": 0,
             "customer_lastname": "string",
             "customer_middlename": "string",
             "customer_note": "string",
             "customer_note_notify": 0,
             "customer_prefix": "string",
             "customer_suffix": "string",
             "customer_taxvat": "string",
             "discount_amount": 0,
             "discount_canceled": 0,
             "discount_description": "string",
             "discount_invoiced": 0,
             "discount_refunded": 0,
             "edit_increment": 0,
             "email_sent": 0,
             "entity_id": 0,
             "ext_customer_id": "string",
             "ext_order_id": "string",
             "forced_shipment_with_invoice": 0,
             "global_currency_code": "string",
             "grand_total": 0,
             "discount_tax_compensation_amount": 0,
             "discount_tax_compensation_invoiced": 0,
             "discount_tax_compensation_refunded": 0,
             "hold_before_state": "string",
             "hold_before_status": "string",
             "increment_id": "string",
             "is_virtual": 0,
             "order_currency_code": "string",
             "original_increment_id": "string",
             "payment_authorization_amount": 0,
             "payment_auth_expiration": 0,
             "protect_code": "string",
             "quote_address_id": 0,
             "quote_id": 0,
             "relation_child_id": "string",
             "relation_child_real_id": "string",
             "relation_parent_id": "string",
             "relation_parent_real_id": "string",
             "remote_ip": "string",
             "shipping_amount": 0,
             "shipping_canceled": 0,
             "shipping_description": "string",
             "shipping_discount_amount": 0,
             "shipping_discount_tax_compensation_amount": 0,
             "shipping_incl_tax": 0,
             "shipping_invoiced": 0,
             "shipping_refunded": 0,
             "shipping_tax_amount": 0,
             "shipping_tax_refunded": 0,
             "state": "string",
             "status": "string",
             "store_currency_code": "string",
             "store_id": 0,
             "store_name": "string",
             "store_to_base_rate": 0,
             "store_to_order_rate": 0,
             "subtotal": 0,
             "subtotal_canceled": 0,
             "subtotal_incl_tax": 0,
             "subtotal_invoiced": 0,
             "subtotal_refunded": 0,
             "tax_amount": 0,
             "tax_canceled": 0,
             "tax_invoiced": 0,
             "tax_refunded": 0,
             "total_canceled": 0,
             "total_due": 0,
             "total_invoiced": 0,
             "total_item_count": 0,
             "total_offline_refunded": 0,
             "total_online_refunded": 0,
             "total_paid": 0,
             "total_qty_ordered": 0,
             "total_refunded": 0,
             "updated_at": "string",
             "weight": 0,
             "x_forwarded_for": "string",
             "items": [
             {
             "additional_data": "string",
             "amount_refunded": 0,
             "applied_rule_ids": "string",
             "base_amount_refunded": 0,
             "base_cost": 0,
             "base_discount_amount": 0,
             "base_discount_invoiced": 0,
             "base_discount_refunded": 0,
             "base_discount_tax_compensation_amount": 0,
             "base_discount_tax_compensation_invoiced": 0,
             "base_discount_tax_compensation_refunded": 0,
             "base_original_price": 0,
             "base_price": 0,
             "base_price_incl_tax": 0,
             "base_row_invoiced": 0,
             "base_row_total": 0,
             "base_row_total_incl_tax": 0,
             "base_tax_amount": 0,
             "base_tax_before_discount": 0,
             "base_tax_invoiced": 0,
             "base_tax_refunded": 0,
             "base_weee_tax_applied_amount": 0,
             "base_weee_tax_applied_row_amnt": 0,
             "base_weee_tax_disposition": 0,
             "base_weee_tax_row_disposition": 0,
             "created_at": "string",
             "description": "string",
             "discount_amount": 0,
             "discount_invoiced": 0,
             "discount_percent": 0,
             "discount_refunded": 0,
             "event_id": 0,
             "ext_order_item_id": "string",
             "free_shipping": 0,
             "gw_base_price": 0,
             "gw_base_price_invoiced": 0,
             "gw_base_price_refunded": 0,
             "gw_base_tax_amount": 0,
             "gw_base_tax_amount_invoiced": 0,
             "gw_base_tax_amount_refunded": 0,
             "gw_id": 0,
             "gw_price": 0,
             "gw_price_invoiced": 0,
             "gw_price_refunded": 0,
             "gw_tax_amount": 0,
             "gw_tax_amount_invoiced": 0,
             "gw_tax_amount_refunded": 0,
             "discount_tax_compensation_amount": 0,
             "discount_tax_compensation_canceled": 0,
             "discount_tax_compensation_invoiced": 0,
             "discount_tax_compensation_refunded": 0,
             "is_qty_decimal": 0
             "is_virtual": 0,
             "item_id": 0,
             "locked_do_invoice": 0,
             "locked_do_ship": 0,
             "name": "string",
             "no_discount": 0,
             "order_id": 0,
             "original_price": 0,
             "parent_item_id": 0,
             "price": 0,
             "price_incl_tax": 0,
             "product_id": 0,
             "product_type": "string",
             "qty_backordered": 0,
             "qty_canceled": 0,
             "qty_invoiced": 0,
             "qty_ordered": 0,
             "qty_refunded": 0,
             "qty_returned": 0,
             "qty_shipped": 0,
             "quote_item_id": 0,
             "row_invoiced": 0,
             "row_total": 0,
             "row_total_incl_tax": 0,
             "row_weight": 0,
             "sku": "string",
             "store_id": 0,
             "tax_amount": 0,
             "tax_before_discount": 0,
             "tax_canceled": 0,
             "tax_invoiced": 0,
             "tax_percent": 0,
             "tax_refunded": 0,
             "updated_at": "string",
             "weee_tax_applied": "string",
             "weee_tax_applied_amount": 0,
             "weee_tax_applied_row_amount": 0,
             "weee_tax_disposition": 0,
             "weee_tax_row_disposition": 0,
             "weight": 0,
             "parent_item": {},
             "product_option": {
             "extension_attributes": {
             "custom_options": [
             {
             "option_id": "string",
             "option_value": "string",
             "extension_attributes": {
              "file_info": {
                            "base64_encoded_data": "string",
                            "type": "string",
                            "name": "string"
              }
             }
             }
             ],
             "bundle_options": [
             {
             "option_id": 0,
             "option_qty": 0,
             "option_selections": [
              0
             ],
             "extension_attributes": {}
             }
             ],
             "configurable_item_options": [
             {
             "option_id": "string",
             "option_value": 0,
             "extension_attributes": {}
             }
             ],
             "downloadable_option": {
             "downloadable_links": [
             0
             ]
             },
             "giftcard_item_option": {
             "giftcard_amount": "string",
             "custom_giftcard_amount": 0,
             "giftcard_sender_name": "string",
             "giftcard_recipient_name": "string",
             "giftcard_sender_email": "string",
             "giftcard_recipient_email": "string",
             "giftcard_message": "string",
             "extension_attributes": {
             "giftcard_created_codes": [
              "string"
             ]
             }
             }
             }
             },
             "extension_attributes": {
             "gift_message": {
             "gift_message_id": 0,
             "customer_id": 0,
             "sender": "string",
             "recipient": "string",
             "message": "string",
             "extension_attributes": {
             "entity_id": "string",
             "entity_type": "string",
             "wrapping_id": 0,
             "wrapping_allow_gift_receipt": true,
             "wrapping_add_printed_card": true
             }
             },
             "gw_id": "string",
             "gw_base_price": "string",
             "gw_price": "string",
             "gw_base_tax_amount": "string",
             "gw_tax_amount": "string",
             "gw_base_price_invoiced": "string",
             "gw_price_invoiced": "string",
             "gw_base_tax_amount_invoiced": "string",
             "gw_tax_amount_invoiced": "string",
             "gw_base_price_refunded": "string",
             "gw_price_refunded": "string",
             "gw_base_tax_amount_refunded": "string",
             "gw_tax_amount_refunded": "string",
             "vertex_tax_codes": [
             "string"
             ],
             "invoice_text_codes": [
             "string"
             ],
             "tax_codes": [
             "string"
             ]
             }
             }
             ],
            "billing_address": {
             "address_type": "string",
             "city": "string",
             "company": "string",
             "country_id": "string",
             "customer_address_id": 0,
             "customer_id": 0,
             "email": "string",
             "entity_id": 0,
             "fax": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "parent_id": 0,
             "postcode": "string",
             "prefix": "string",
             "region": "string",
             "region_code": "string",
             "region_id": 0,
             "street": [
             "string"
             ],
             "suffix": "string",
             "telephone": "string",
             "vat_id": "string",
            "vat_is_valid": 0,
             "vat_request_date": "string",
             "vat_request_id": "string",
             "vat_request_success": 0,
             "extension_attributes": {}
             },
             "payment": {
             "account_status": "string",
             "additional_data": "string",
             "additional_information": [
             "string"
             ],
             "address_status": "string",
             "amount_authorized": 0,
             "amount_canceled": 0,
             "amount_ordered": 0,
             "amount_paid": 0,
             "amount_refunded": 0,
             "anet_trans_method": "string",
             "base_amount_authorized": 0,
             "base_amount_canceled": 0,
             "base_amount_ordered": 0,
             "base_amount_paid": 0,
             "base_amount_paid_online": 0,
             "base_amount_refunded": 0,
             "base_amount_refunded_online": 0,
             "base_shipping_amount": 0,
             "base_shipping_captured": 0,
             "base_shipping_refunded": 0,
             "cc_approval": "string",
             "cc_avs_status": "string",
             "cc_cid_status": "string",
             "cc_debug_request_body": "string",
             "cc_debug_response_body": "string",
             "cc_debug_response_serialized": "string",
             "cc_exp_month": "string",
             "cc_exp_year": "string",
             "cc_last4": "string",
             "cc_number_enc": "string",
             "cc_owner": "string",
             "cc_secure_verify": "string",
             "cc_ss_issue": "string",
             "cc_ss_start_month": "string",
             "cc_ss_start_year": "string",
             "cc_status": "string",
             "cc_status_description": "string",
             "cc_trans_id": "string",
             "cc_type": "string",
             "echeck_account_name": "string",
             "echeck_account_type": "string",
             "echeck_bank_name": "string",
             "echeck_routing_number": "string",
             "echeck_type": "string",
             "entity_id": 0,
             "last_trans_id": "string",
             "method": "string",
             "parent_id": 0,
             "po_number": "string",
             "protection_eligibility": "string",
             "quote_payment_id": 0,
             "shipping_amount": 0,
             "shipping_captured": 0,
            "shipping_refunded": 0,
             "extension_attributes": {
             "vault_payment_token": {
             "entity_id": 0,
             "customer_id": 0,
             "public_hash": "string",
             "payment_method_code": "string",
             "type": "string",
             "created_at": "string",
             "expires_at": "string",
             "gateway_token": "string",
             "token_details": "string",
             "is_active": true,
             "is_visible": true
             }
             }
             },
             "status_histories": [
             {
             "comment": "string",
             "created_at": "string",
             "entity_id": 0,
             "entity_name": "string",
             "is_customer_notified": 0,
             "is_visible_on_front": 0,
             "parent_id": 0,
             "status": "string",
             "extension_attributes": {}
             }
             ],
             "extension_attributes": {
             "shipping_assignments": [
             {
             "shipping": {
             "address": {
             "address_type": "string",
             "city": "string",
             "company": "string",
             "country_id": "string",
             "customer_address_id": 0,
             "customer_id": 0,
             "email": "string",
             "entity_id": 0,
             "fax": "string",
             "firstname": "string",
             "lastname": "string",
             "middlename": "string",
             "parent_id": 0,
             "postcode": "string",
             "prefix": "string",
             "region": "string",
             "region_code": "string",
             "region_id": 0,
             "street": [
             "string"
             ],
             "suffix": "string",
             "telephone": "string",
             "vat_id": "string",
             "vat_is_valid": 0,
             "vat_request_date": "string",
             "vat_request_id": "string",
            "vat_request_success": 0,
             "extension_attributes": {}
             },
             "method": "string",
             "total": {
             "base_shipping_amount": 0,
             "base_shipping_canceled": 0,
             "base_shipping_discount_amount": 0,
             "base_shipping_discount_tax_compensation_amnt": 0,
             "base_shipping_incl_tax": 0,
             "base_shipping_invoiced": 0,
             "base_shipping_refunded": 0,
             "base_shipping_tax_amount": 0,
             "base_shipping_tax_refunded": 0,
             "shipping_amount": 0,
             "shipping_canceled": 0,
             "shipping_discount_amount": 0,
             "shipping_discount_tax_compensation_amount": 0,
             "shipping_incl_tax": 0,
             "shipping_invoiced": 0,
             "shipping_refunded": 0,
             "shipping_tax_amount": 0,
             "shipping_tax_refunded": 0,
             "extension_attributes": {}
             },
             "extension_attributes": {}
             },
             "items": [
             {
             "additional_data": "string",
             "amount_refunded": 0,
             "applied_rule_ids": "string",
             "base_amount_refunded": 0,
             "base_cost": 0,
             "base_discount_amount": 0,
             "base_discount_invoiced": 0,
             "base_discount_refunded": 0,
             "base_discount_tax_compensation_amount": 0,
             "base_discount_tax_compensation_invoiced": 0,
             "base_discount_tax_compensation_refunded": 0,
             "base_original_price": 0,
             "base_price": 0,
             "base_price_incl_tax": 0,
             "base_row_invoiced": 0,
             "base_row_total": 0,
             "base_row_total_incl_tax": 0,
             "base_tax_amount": 0,
             "base_tax_before_discount": 0,
             "base_tax_invoiced": 0,
             "base_tax_refunded": 0,
             "base_weee_tax_applied_amount": 0,
             "base_weee_tax_applied_row_amnt": 0,
             "base_weee_tax_disposition": 0,
             "base_weee_tax_row_disposition": 0,
             "created_at": "string",
             "description": "string",
             "discount_amount": 0,
             "discount_invoiced": 0,
             "discount_percent": 0,
             "discount_refunded": 0,
             "event_id": 0,
             "ext_order_item_id": "string",
             "free_shipping": 0,
             "gw_base_price": 0,
             "gw_base_price_invoiced": 0,
             "gw_base_price_refunded": 0,
             "gw_base_tax_amount": 0,
             "gw_base_tax_amount_invoiced": 0,
             "gw_base_tax_amount_refunded": 0,
             "gw_id": 0,
             "gw_price": 0,
             "gw_price_invoiced": 0,
             "gw_price_refunded": 0,
             "gw_tax_amount": 0,
             "gw_tax_amount_invoiced": 0,
             "gw_tax_amount_refunded": 0,
             "discount_tax_compensation_amount": 0,
             "discount_tax_compensation_canceled": 0,
             "discount_tax_compensation_invoiced": 0,
             "discount_tax_compensation_refunded": 0,
             "is_qty_decimal": 0,
             "is_virtual": 0,
             "item_id": 0,
             "locked_do_invoice": 0,
             "locked_do_ship": 0,
             "name": "string",
             "no_discount": 0,
             "order_id": 0,
             "original_price": 0,
             "parent_item_id": 0,
             "price": 0,
             "price_incl_tax": 0,
             "product_id": 0,
             "product_type": "string",
             "qty_backordered": 0,
             "qty_canceled": 0,
             "qty_invoiced": 0,
             "qty_ordered": 0,
             "qty_refunded": 0,
             "qty_returned": 0,
             "qty_shipped": 0,
             "quote_item_id": 0,
             "row_invoiced": 0,
             "row_total": 0,
             "row_total_incl_tax": 0,
             "row_weight": 0,
             "sku": "string",
             "store_id": 0,
             "tax_amount": 0,
             "tax_before_discount": 0,
             "tax_canceled": 0,
             "tax_invoiced": 0,
             "tax_percent": 0,
             "tax_refunded": 0,
             "updated_at": "string",
             "weee_tax_applied": "string",
             "weee_tax_applied_amount": 0,
             "weee_tax_applied_row_amount": 0,
             "weee_tax_disposition": 0,
             "weee_tax_row_disposition": 0,
             "weight": 0,
             "parent_item": {},
             "product_option": {
             "extension_attributes": {
              "custom_options": [
                            {
                            "option_id": "string",
                            "option_value": "string",
                            "extension_attributes": {
                            "file_info": {
                            "base64_encoded_data": "string",
                            "type": "string",
                            "name": "string"
                            }
                            }
                            }
              ],
              "bundle_options": [
                            {
                            "option_id": 0,
                            "option_qty": 0,
                            "option_selections": [
                            0
                            ],
                            "extension_attributes": {}
                            }
              ],
              "configurable_item_options": [
                            {
                            "option_id": "string",
                            "option_value": 0,
                            "extension_attributes": {}
                            }
              ],
              "downloadable_option": {
                            "downloadable_links": [
                            0
                            ]
              },
              "giftcard_item_option": {
                            "giftcard_amount": "string",
                            "custom_giftcard_amount": 0,
                            "giftcard_sender_name": "string",
                            "giftcard_recipient_name": "string",
                            "giftcard_sender_email": "string",
                            "giftcard_recipient_email": "string",
                            "giftcard_message": "string",
                            "extension_attributes": {
                            "giftcard_created_codes": [
                            "string"
                            ]
                            }
              }
             }
             },
             "extension_attributes": {
             "gift_message": {
              "gift_message_id": 0,
              "customer_id": 0,
              "sender": "string",
              "recipient": "string",
              "message": "string",
              "extension_attributes": {
                            "entity_id": "string",
                            "entity_type": "string",
                            "wrapping_id": 0,
                            "wrapping_allow_gift_receipt": true,
                            "wrapping_add_printed_card": true
              }
             },
             "gw_id": "string",
             "gw_base_price": "string",
             "gw_price": "string",
             "gw_base_tax_amount": "string",
             "gw_tax_amount": "string",
             "gw_base_price_invoiced": "string",
             "gw_price_invoiced": "string",
             "gw_base_tax_amount_invoiced": "string",
             "gw_tax_amount_invoiced": "string",
             "gw_base_price_refunded": "string",
             "gw_price_refunded": "string",
             "gw_base_tax_amount_refunded": "string",
             "gw_tax_amount_refunded": "string",
             "vertex_tax_codes": [
              "string"
             ],
             "invoice_text_codes": [
              "string"
             ],
             "tax_codes": [
              "string"
             ]
             }
             }
             ],
             "stock_id": 0,
             "extension_attributes": {}
             }
             ],
             "payment_additional_info": [
             {
             "key": "string",
             "value": "string"
             }
             ],
             "applied_taxes": [
             {
             "code": "string",
             "title": "string",
             "percent": 0,
             "amount": 0,
             "base_amount": 0,
             "extension_attributes": {
             "rates": [
             {
             "code": "string",
             "title": "string",
             "percent": 0,
             "extension_attributes": {}
             }
             ]
             }
             }
             ],
             "item_applied_taxes": [
             {
             "type": "string",
             "item_id": 0,
             "associated_item_id": 0,
             "applied_taxes": [
             {
             "code": "string",
             "title": "string",
             "percent": 0,
             "amount": 0,
             "base_amount": 0,
             "extension_attributes": {
             "rates": [
              {
                            "code": "string",
                            "title": "string",
                            "percent": 0,
                            "extension_attributes": {}
              }
             ]
             }
             }
             ],
             "extension_attributes": {}
             }
             ],
             "converting_from_quote": true,
             "company_order_attributes": {
             "order_id": 0,
             "company_id": 0,
             "company_name": "string",
             "extension_attributes": {}
             },
             "base_customer_balance_amount": 0,
             "customer_balance_amount": 0,
             "base_customer_balance_invoiced": 0,
             "customer_balance_invoiced": 0,
             "base_customer_balance_refunded": 0,
             "customer_balance_refunded": 0,
             "base_customer_balance_total_refunded": 0,
             "customer_balance_total_refunded": 0,
             "gift_cards": [
             {
             "id": 0,
             "code": "string",
             "amount": 0,
             "base_amount": 0
             }
             ],
             "base_gift_cards_amount": 0,
             "gift_cards_amount": 0,
             "base_gift_cards_invoiced": 0,
             "gift_cards_invoiced": 0,
             "base_gift_cards_refunded": 0,
             "gift_cards_refunded": 0,
             "gift_message": {
             "gift_message_id": 0,
             "customer_id": 0,
             "sender": "string",
             "recipient": "string",
             "message": "string",
             "extension_attributes": {
             "entity_id": "string",
             "entity_type": "string",
             "wrapping_id": 0,
             "wrapping_allow_gift_receipt": true,
             "wrapping_add_printed_card": true
             }
             },
             "gw_id": "string",
             "gw_allow_gift_receipt": "string",
             "gw_add_card": "string",
             "gw_base_price": "string",
             "gw_price": "string",
             "gw_items_base_price": "string",
             "gw_items_price": "string",
             "gw_card_base_price": "string",
             "gw_card_price": "string",
             "gw_base_tax_amount": "string",
             "gw_tax_amount": "string",
             "gw_items_base_tax_amount": "string",
             "gw_items_tax_amount": "string",
             "gw_card_base_tax_amount": "string",
             "gw_card_tax_amount": "string",
             "gw_base_price_incl_tax": "string",
             "gw_price_incl_tax": "string",
             "gw_items_base_price_incl_tax": "string",
             "gw_items_price_incl_tax": "string",
             "gw_card_base_price_incl_tax": "string",
             "gw_card_price_incl_tax": "string",
             "gw_base_price_invoiced": "string",
             "gw_price_invoiced": "string",
             "gw_items_base_price_invoiced": "string",
             "gw_items_price_invoiced": "string",
             "gw_card_base_price_invoiced": "string",
             "gw_card_price_invoiced": "string",
             "gw_base_tax_amount_invoiced": "string",
             "gw_tax_amount_invoiced": "string",
             "gw_items_base_tax_invoiced": "string",
             "gw_items_tax_invoiced": "string",
             "gw_card_base_tax_invoiced": "string",
             "gw_card_tax_invoiced": "string",
             "gw_base_price_refunded": "string",
             "gw_price_refunded": "string",
             "gw_items_base_price_refunded": "string",
             "gw_items_price_refunded": "string",
             "gw_card_base_price_refunded": "string",
             "gw_card_price_refunded": "string",
             "gw_base_tax_amount_refunded": "string",
             "gw_tax_amount_refunded": "string",
             "gw_items_base_tax_refunded": "string",
             "gw_items_tax_refunded": "string",
             "gw_card_base_tax_refunded": "string",
             "gw_card_tax_refunded": "string",
             "reward_points_balance": 0,
             "reward_currency_amount": 0,
             "base_reward_currency_amount": 0,
             "amazon_order_reference_id": {
             "amazon_order_reference_id": "string",
             "order_id": 0
             }
             }
 }
}

Back to TOPICS

Orders/Items

This request lists order items that match specified search criteria in the Lambda Store.

Schema (Application/JSON):

searchCriteria[currentPage] Integer Current Page
searchCriteria[filterGroups][0][filters][0][conditionType] String Condition Type
searchCriteria[filterGroups][0][filters][0][field] String Field
searchCriteria[filterGroups][0][value] String Value
searchCriteria[pageSize] Integer Page Size
searchCriteria[sortOrders][0][direction] String Sorting Direction
searchCriteria[sortOrders][0][field] String Sorting Field

Back to TOPICS

Orders/{id}

This request loads a specific order in the Lambda Store.

Schema (Application/JSON):

  • id (Required): Integer
GET /V1/orders/{id}

Back to TOPICS

Orders/{id}/Statuses

This request gets the status of a specified order in the Lambda Store.

Schema (Application/JSON):

  • id (Required): Integer
GET /V1/orders/{id}/statuses

Back to TOPICS


Products

Products (Retrieve)

This request gets a list of products in the Lambda Store.

Schema (Application/JSON):

searchCriteria[currentPage] Integer Current Page
searchCriteria[filterGroups][0][filters][0][conditionType] String Condition Type
searchCriteria[filterGroups][0][filters][0][field] String Field
searchCriteria[filterGroups][0][value] String Value
searchCriteria[pageSize] Integer Page Size
searchCriteria[sortOrders][0][direction] String Sorting Direction
searchCriteria[sortOrders][0][field] String Sorting Field
GET /V1/products

Back to TOPICS

Products (Create)

This request creates products in the Lambda Store.

Schema (Application/JSON):

  • product (Required): Product Object
GET /V1/products

Sample:
{
 "product": {
             "id": 0,
             "sku": "string",
             "name": "string",
             "attribute_set_id": 0,
             "price": 0,
             "status": 0,
             "visibility": 0,
             "type_id": "string",
             "created_at": "string",
             "updated_at": "string",
             "weight": 0,
             "extension_attributes": {
             "website_ids": [
             0
             ],
             "category_links": [
             {
             "position": 0,
             "category_id": "string",
             "extension_attributes": {}
             }
             ],
             "stock_item": {
             "item_id": 0,
             "product_id": 0,
             "stock_id": 0,
             "qty": 0,
             "is_in_stock": true,
             "is_qty_decimal": true,
             "show_default_notification_message": true,
             "use_config_min_qty": true,
             "min_qty": 0,
             "use_config_min_sale_qty": 0,
             "min_sale_qty": 0,
             "use_config_max_sale_qty": true,
             "max_sale_qty": 0,
             "use_config_backorders": true,
             "backorders": 0,
             "use_config_notify_stock_qty": true,
             "notify_stock_qty": 0,
             "use_config_qty_increments": true,
             "qty_increments": 0,
             "use_config_enable_qty_inc": true,
             "enable_qty_increments": true,
             "use_config_manage_stock": true,
             "manage_stock": true,
             "low_stock_date": "string",
             "is_decimal_divided": true,
             "stock_status_changed_auto": 0,
             "extension_attributes": {}
             },
             "bundle_product_options": [
             {
             "option_id": 0,
             "title": "string",
             "required": true,
             "type": "string",
             "position": 0,
             "sku": "string",
             "product_links": [
             {
             "id": "string",
             "sku": "string",
             "option_id": 0,
             "qty": 0,
             "position": 0,
             "is_default": true,
             "price": 0,
             "price_type": 0,
             "can_change_quantity": 0,
             "extension_attributes": {}
             }
             ],
             "extension_attributes": {}
             }
             ],
             "configurable_product_options": [
             {
             "id": 0,
             "attribute_id": "string",
             "label": "string",
             "position": 0,
             "is_use_default": true,
             "values": [
             {
             "value_index": 0,
             "extension_attributes": {}
             }
             ],
             "extension_attributes": {},
             "product_id": 0
             }
             ],
             "configurable_product_links": [
             0
             ],
             "downloadable_product_links": [
             {
             "id": 0,
             "title": "string",
             "sort_order": 0,
             "is_shareable": 0,
             "price": 0,
             "number_of_downloads": 0,
             "link_type": "string",
             "link_file": "string",
             "link_file_content": {
             "file_data": "string",
             "name": "string",
             "extension_attributes": {}
             },
             "link_url": "string",
             "sample_type": "string",
             "sample_file": "string",
             "sample_file_content": {
             "file_data": "string",
             "name": "string",
             "extension_attributes": {}
             },
             "sample_url": "string",
             "extension_attributes": {}
             }
             ],
             "downloadable_product_samples": [
             {

"id": 0,
             "title": "string",
             "sort_order": 0,
             "sample_type": "string",
             "sample_file": "string",
             "sample_file_content": {
             "file_data": "string",
             "name": "string",
             "extension_attributes": {}
             },
             "sample_url": "string",
             "extension_attributes": {}
             }
             ],
             "giftcard_amounts":
             {
             "attribute_id": 0,
             "website_id": 0,
             "value": 0,
             "website_value": 0,
             "extension_attributes": {}
             }
             ]
             },
             "product_links": [
             {
             "sku": "string",
             "link_type": "string",
             "linked_product_sku": "string",
             "linked_product_type": "string",
             "position": 0,
             "extension_attributes": {
             "qty": 0
             }
             }
             ],
             "options": [
             {
             "product_sku": "string",
             "option_id": 0,
             "title": "string",
             "type": "string",
             "sort_order": 0,
             "is_require": true,
             "price": 0,
             "price_type": "string",
             "sku": "string",
             "file_extension": "string",
             "max_characters": 0,
             "image_size_x": 0,
             "image_size_y": 0,
             "values": [
             {
             "title": "string",
             "sort_order": 0,
             "price": 0,
             "price_type": "string",
             "sku": "string",
             "option_type_id": 0
             }
             ],
             "extension_attributes": {
             "vertex_flex_field": "string"
             }
             }
             ],
             "media_gallery_entries": [
             {
             "id": 0,
             "media_type": "string",
             "label": "string",
             "position": 0,
             "disabled": true,
             "types": [
             "string"
             ],
             "file": "string",
             "content": {
             "base64_encoded_data": "string",
             "type": "string",
             "name": "string"
             },
             "extension_attributes": {
             "video_content": {
             "media_type": "string",
             "video_provider": "string",
             "video_url": "string",
             "video_title": "string",
             "video_description": "string",
             "video_metadata": "string"
             }
             }
             }
             ],
             "tier_prices": [
             {
             "customer_group_id": 0,
             "qty": 0,
             "value": 0,
             "extension_attributes": {
             "percentage_value": 0,
             "website_id": 0
             }
             }
             ],
             "custom_attributes": [
             {
             "attribute_code": "string",
             "value": "string"
             }
             ]
 },
 "saveOptions": true
}

Back to TOPICS

Products/{SKU}

This request gets information about a product by product SKU in the Lambda Store.

Schema (Application/JSON):

  • sku (Required): String
GET /V1/products/{sku}

Back to TOPICS


WebHooks

Configuration

There are two settings: The URL that Lambda will publish to, and an API key. The integrator will produce the URL and API key to Lambda.

Orders

Response JSON:


{"OrderNumber":"000000127",
"OrderDate":"2020-04-09 10:03:31",
"OrderStatus":"Pending",
"OrderPaymentMethod":"Check \/ Money order",
"CustomerName":"John Doe",
"CustomerEmail":"john.doe@example.com",
"CustomerBillingAddress":{"Street":"Some Street 13",
                            "City":"Some City",
                            "State\/Province":null,
                            "Country":"CA",
                            "Zip\/PostalCode":"555555",
                            "PhoneNumber":"5555555"}}

Back to TOPICS