{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:fulfillment/get-accounting":{"get":{"operationId":"ecommerce_fulfillment_get_accounting","summary":"List Order Accounting","description":"GET /accounting","tags":["ecommerce"],"parameters":[{"name":"fromDate","in":"query","required":true,"description":"Orders invoice date. Date-time in ISO 8601 format for selecting orders after, or at, the specified time","schema":{"type":"string","description":"Orders invoice date. Date-time in ISO 8601 format for selecting orders after, or at, the specified time"}},{"name":"toDate","in":"query","required":true,"description":"Orders invoice date. Date-time in ISO 8601 format for selecting orders before, or at, the specified time","schema":{"type":"string","description":"Orders invoice date. Date-time in ISO 8601 format for selecting orders before, or at, the specified time"}},{"name":"page","in":"query","required":false,"description":"A multiplier of the number of items (limit parameter) to skip before returning results","schema":{"type":"integer","default":1,"description":"A multiplier of the number of items (limit parameter) to skip before returning results"}},{"name":"limit","in":"query","required":false,"description":"The numbers of items to return","schema":{"type":"integer","default":80,"description":"The numbers of items to return"}},{"name":"warehouseIds","in":"query","required":false,"description":"A CSV of warehouse id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of warehouse id, '123' or '1,2,3'"}},{"name":"orderIds","in":"query","required":false,"description":"A CSV of FDC order id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of FDC order id, '123' or '1,2,3'"}},{"name":"hydrate","in":"query","required":true,"description":"Adds additional information to the response, uses a CSV format for multiple values.","schema":{"type":"array","description":"Adds additional information to the response, uses a CSV format for multiple values."},"example":"items"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-inventory":{"get":{"operationId":"ecommerce_fulfillment_get_inventory","summary":"List of Item Inventories","description":"GET /inventory","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"A multiplier of the number of items (limit parameter) to skip before returning results","schema":{"type":"integer","default":1,"description":"A multiplier of the number of items (limit parameter) to skip before returning results"}},{"name":"limit","in":"query","required":false,"description":"The numbers of items to return","schema":{"type":"integer","default":80,"description":"The numbers of items to return"}},{"name":"merchantIds","in":"query","required":false,"description":"A CSV of merchant id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of merchant id, '123' or '1,2,3'"}},{"name":"warehouseIds","in":"query","required":false,"description":"A CSV of warehouse id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of warehouse id, '123' or '1,2,3'"}},{"name":"externalSkuNames","in":"query","required":false,"description":"A CSV of sku reference names, 'skuName1' or 'skuName1,skuName2,skuName3'","schema":{"type":"array","description":"A CSV of sku reference names, 'skuName1' or 'skuName1,skuName2,skuName3'"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/post-oauth-access-token":{"post":{"operationId":"ecommerce_fulfillment_post_oauth_access_token","summary":"Generate an Access Token","description":"POST /oauth/access_token","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-orders":{"get":{"operationId":"ecommerce_fulfillment_get_orders","summary":"List of Orders","description":"GET /orders","tags":["ecommerce"],"parameters":[{"name":"fromDate","in":"query","required":true,"description":"Date-time in ISO 8601 format for selecting orders after, or at, the specified time","schema":{"type":"string","description":"Date-time in ISO 8601 format for selecting orders after, or at, the specified time"}},{"name":"toDate","in":"query","required":true,"description":"Date-time in ISO 8601 format for selecting orders before, or at, the specified time","schema":{"type":"string","description":"Date-time in ISO 8601 format for selecting orders before, or at, the specified time"}},{"name":"merchantIds","in":"query","required":false,"description":"A CSV of merchant id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of merchant id, '123' or '1,2,3'"}},{"name":"warehouseIds","in":"query","required":false,"description":"A CSV of warehouse id, '123' or '1,2,3'","schema":{"type":"array","description":"A CSV of warehouse id, '123' or '1,2,3'"}},{"name":"page","in":"query","required":false,"description":"A multiplier of the number of items (limit parameter) to skip before returning results","schema":{"type":"integer","default":1,"description":"A multiplier of the number of items (limit parameter) to skip before returning results"}},{"name":"limit","in":"query","required":false,"description":"The numbers of items to return","schema":{"type":"integer","default":80,"description":"The numbers of items to return"}},{"name":"hydrate","in":"query","required":false,"description":"Adds additional information to the response, uses a CSV format for multiple values.'","schema":{"type":"array","description":"Adds additional information to the response, uses a CSV format for multiple values.'"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/post-orders":{"post":{"operationId":"ecommerce_fulfillment_post_orders","summary":"New Order","description":"POST /orders","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-order":{"get":{"operationId":"ecommerce_fulfillment_get_order","summary":"Order Details","description":"GET /orders/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The FDC order Id","schema":{"type":"string","description":"The FDC order Id"}},{"name":"merchantId","in":"query","required":false,"description":"Providing your `merchantId` indicates the `id` is your `merchantOrderId`. Although it is not necessary to provide this it will speed up…","schema":{"type":"integer","description":"Providing your `merchantId` indicates the `id` is your `merchantOrderId`. Although it is not necessary to provide this it will speed up…"}},{"name":"hydrate","in":"query","required":false,"description":"Adds additional information to the response, uses a CSV format for multiple values.'","schema":{"type":"array","description":"Adds additional information to the response, uses a CSV format for multiple values.'"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/delete-orders-id":{"post":{"operationId":"ecommerce_fulfillment_delete_orders_id","summary":"Cancel an Order","description":"DELETE /orders/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"ID of order that needs to be canceled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/put-orders-id-ship":{"post":{"operationId":"ecommerce_fulfillment_put_orders_id_ship","summary":"Ship an Order","description":"PUT /orders/{id}/ship","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The FDC order Id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/put-orders-id-status":{"post":{"operationId":"ecommerce_fulfillment_put_orders_id_status","summary":"Update Order Status","description":"PUT /orders/{id}/status","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The FDC order Id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-returns":{"get":{"operationId":"ecommerce_fulfillment_get_returns","summary":"List Returns","description":"GET /returns","tags":["ecommerce"],"parameters":[{"name":"fromDate","in":"query","required":true,"description":"Date-time in ISO 8601 format for selecting orders after, or at, the specified time","schema":{"type":"string","description":"Date-time in ISO 8601 format for selecting orders after, or at, the specified time"}},{"name":"toDate","in":"query","required":true,"description":"Date-time in ISO 8601 format for selecting orders before, or at, the specified time","schema":{"type":"string","description":"Date-time in ISO 8601 format for selecting orders before, or at, the specified time"}},{"name":"page","in":"query","required":false,"description":"A multiplier of the number of items (limit parameter) to skip before returning results","schema":{"type":"integer","default":1,"description":"A multiplier of the number of items (limit parameter) to skip before returning results"}},{"name":"limit","in":"query","required":false,"description":"The numbers of items to return","schema":{"type":"integer","default":80,"description":"The numbers of items to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/put-returns":{"post":{"operationId":"ecommerce_fulfillment_put_returns","summary":"Inform us of an RMA","description":"PUT /returns","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-track":{"get":{"operationId":"ecommerce_fulfillment_get_track","summary":"Tracking","description":"GET /track","tags":["ecommerce"],"parameters":[{"name":"trackingNumber","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:fulfillment/get-users-me":{"get":{"operationId":"ecommerce_fulfillment_get_users_me","summary":"About Me","description":"GET /users/me","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}