@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Ecommerce API
@base https://unify.apideck.com
@version 10.24.12
@auth ApiKey Authorization in header
@common_fields {x-apideck-consumer-id: str, x-apideck-app-id: str, raw: bool=false, x-apideck-service-id: str, fields: str}
@endpoints 7
@toc ecommerce(7)

@endpoint GET /ecommerce/orders
@optional {cursor: str, limit: int=20, filter: map, sort: map, pass_through: map}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], _raw: map?, meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/orders/{id}
@required {id: str}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, order_number: str?, currency: str?, discounts: [map], sub_total: str?, shipping_cost: str?, coupon_discount: str?, total_discount: str?, total_tax: str?, total_amount: str?, refunded_amount: str?, status: str?, payment_status: str?, fulfillment_status: str?, payment_method: str?, customer: map{id: str?, name: str?, first_name: str?, last_name: str?, company_name: str?, phone_numbers: [map]?, emails: [map]?}, billing_address: map{line1: str?, line2: str?, company_name: str?, city: str?, state: str?, postal_code: str?, country: str?}, shipping_address: map{line1: str?, line2: str?, company_name: str?, city: str?, state: str?, postal_code: str?, country: str?}, tracking: [map], line_items: [map], note: str?, refunds: [map], custom_mappings: map?, created_at: str(date-time)?, updated_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/products
@optional {cursor: str, limit: int=20, pass_through: map, filter: map}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], _raw: map?, meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/products/{id}
@required {id: str}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str?, description: str?, status: str?, price: str?, sku: str?, inventory_quantity: str?, images: [map]?, weight: str?, weight_unit: str?, options: [map], variants: [map], tags: [str], categories: [map], custom_mappings: map?, created_at: str(date-time)?, updated_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/customers
@optional {cursor: str, limit: int=20, filter: map, pass_through: map}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], _raw: map?, meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/customers/{id}
@required {id: str}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str?, first_name: str?, last_name: str?, company_name: str?, status: str?, currency: str?, emails: [map]?, phone_numbers: [map]?, addresses: [map], orders: [map], custom_mappings: map?, created_at: str(date-time)?, updated_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /ecommerce/store
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, name: str?, store_url: str(uri)?, admin_url: str(uri)?, custom_mappings: map?, created_at: str(date-time)?, updated_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@end