{"swagger":"2.0","info":{"version":"1.0.0","title":"3DImager","description":"3D Imager API"},"paths":{"/4DRetailTech/3DImager/Record/json":{"get":{"summary":"Get record in Json format","description":"This returns the record in json format. You have to pass the access token in the request. The response has a field called \"Record_Num\". Once the processing is done from your end you have to call /4DRetailTech/3DImager/UpdateStatus endpoint by sending the record number in it to set the status of record as processed.","operationId":"getIndividualRecordValueInJson","tags":["Deprecated"],"parameters":[{"$ref":"#/parameters/recordNo"},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned record value","schema":{"$ref":"#/definitions/Record"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/Record/csv":{"get":{"summary":"Get record in CSV format","description":"This returns the record in comma seperated values (CSV). See the sample in the Responses section below. You have to pass the access token in the request. The first value in the comma seperated response is the record number. Once the processing is done from your end you have to call /4DRetailTech/3DImager/UpdateStatus endpoint by sending the record number in it to set the status of record as processed.","operationId":"getIndividualRecordValueInCSV","tags":["Deprecated"],"parameters":[{"$ref":"#/parameters/recordNo"},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned record value","schema":{"type":"string","example":"1,01-02-2018:17:22:34,014100088356,http:4dapistartus.htmimagingprocessingstarted_Record_num[1],Verson.2.3,Rect,8.5,2.5,6.5,n,\"-20,-15,-10,-5,0,5,10,15,21\",1200.0,n,1000.0,100.0,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,Y,c:ouput3984983498394ANG.-20-UPC-033434343434-TOP.jpg,N,http:www.4dimages83459832954823929384.htm,http:www.4dimagescompleted-api-form-images823929384.htm,Default.max,shelf.3ds,texture_locations"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/NextRecord/json":{"get":{"summary":"Get next record in Json format","description":"This returns the next record in json format. You have to pass the access token in the request. The response has a field called \"Record_Num\". Once the processing is done from your end you have to call /4DRetailTech/3DImager/UpdateStatus endpoint by sending the record number in it to set the status of record as processed. Or else this endpoint will return the same data all the time.","operationId":"getRecordValueInJson","tags":["Deprecated"],"parameters":[{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned record value","schema":{"$ref":"#/definitions/Record"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/NextRecord/csv":{"get":{"summary":"Get next record in CSV format","description":"This returns the next record in comma seperated values (CSV). See the sample in the Responses section below. You have to pass the access token in the request. The first value in the comma seperated response is the record number. Once the processing is done from your end you have to call /4DRetailTech/3DImager/UpdateStatus endpoint by sending the record number in it to set the status of record as processed. Or else this endpoint will return the same data all the time.","operationId":"getRecordValueInCSV","tags":["Deprecated"],"parameters":[{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned record value","schema":{"type":"string","example":"1,01-02-2018:17:22:34,014100088356,http:4dapistartus.htmimagingprocessingstarted_Record_num[1],Verson.2.3,Rect,8.5,2.5,6.5,n,\"-20,-15,-10,-5,0,5,10,15,21\",1200.0,n,1000.0,100.0,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,https://s3.amazonaws.com/4sspacegenius/walmartimages/014100046165_PV___y9_CROP.jpg,Y,c:ouput3984983498394ANG.-20-UPC-033434343434-TOP.jpg,N,http:www.4dimages83459832954823929384.htm,http:www.4dimagescompleted-api-form-images823929384.htm,Default.max,shelf.3ds,texture_locations"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/UpdateStatus":{"post":{"summary":"Update record's status","description":"You have to pass the record number and accesstoken in the request in order to set the record's state as processed. This will return a boolean value true which says the updation was successful.","operationId":"updateState","tags":["Deprecated"],"parameters":[{"$ref":"#/parameters/recordNo"},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Updated state","schema":{"type":"boolean"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/products":{"get":{"summary":"Get products of a planogram","operationId":"getProducts","tags":["Store"],"produces":["application/json"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"$ref":"#/parameters/planogramName"},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned products","schema":{"type":"array","items":{"$ref":"#/definitions/Product"}}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/fixtures":{"get":{"summary":"Get fixtures of a planogram","operationId":"getFixtures","tags":["Store"],"produces":["application/json"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"$ref":"#/parameters/planogramName"},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned fixtures","schema":{"type":"array","items":{"$ref":"#/definitions/Fixture"}}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/connected-planograms/list":{"get":{"summary":"Get connected planograms groups","operationId":"getConnectedPlanogramGroups","tags":["Store"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned planograms groups","schema":{"type":"array","items":{"$ref":"#/definitions/PlanogramGroup"}}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/connected-planograms/{indexNo}":{"get":{"summary":"Get connected planograms sequence","operationId":"getConnectedPlanogramSequence","tags":["Store"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"name":"indexNo","type":"integer","in":"path","description":"Index Number","required":true},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned planograms sequence","schema":{"$ref":"#/definitions/PlanogramSequence"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/connected-planograms/search":{"get":{"summary":"Get connected planograms sequence search","operationId":"getConnectedPlanogramSequenceSearch","tags":["Store"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"name":"planogramName","type":"string","in":"query","description":"Planogram Name","required":true},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned planograms sequence","schema":{"$ref":"#/definitions/PlanogramSequence"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/planograms/{name}":{"get":{"summary":"Get planogram data","operationId":"getPlanogram","tags":["Store"],"produces":["application/json"],"parameters":[{"name":"storeId","type":"string","in":"query","description":"Store Id","required":true},{"name":"name","type":"string","in":"path","description":"Planogram Name (Eg - 6ADA0800.TLN)","required":true},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Returned planograms","schema":{"$ref":"#/definitions/Planogram"}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/company/list":{"get":{"summary":"Get company list","operationId":"getCompanyList","tags":["Store"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Company List","schema":{"type":"array","items":{"$ref":"#/definitions/Company"}}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}},"/4DRetailTech/3DImager/stores/list":{"get":{"summary":"Get stores","operationId":"getStores","tags":["Store"],"produces":["application/json"],"parameters":[{"name":"companyId","type":"string","in":"query","description":"Company Id","required":true},{"$ref":"#/parameters/accessToken"}],"responses":{"200":{"description":"Store List","schema":{"type":"array","items":{"$ref":"#/definitions/Store"}}},"401":{"description":"Unauthorized"},"400":{"description":"Invalid id supplied"},"403":{"description":"Forbidden error"},"500":{"description":"Error occurred"}}}}},"definitions":{"Planogram":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fixtureName":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"rotation":{"type":"number"},"description":{"type":"string"},"numberOfFixtures":{"type":"integer"},"numberOfProductsAllocated":{"type":"integer"},"numberOfSegments":{"type":"integer"},"numberOfSections":{"type":"integer"},"locationId":{"type":"string"},"partId":{"type":"string"},"hFixture":{"type":"number"},"wFixture":{"type":"number"},"dFixture":{"type":"number"},"assembly":{"type":"string"},"bitmapId":{"type":"string"},"baseWidth":{"type":"number"},"baseHeight":{"type":"number"},"baseDepth":{"type":"number"},"backDepth":{"type":"number"},"fileName":{"type":"string"},"color":{"type":"string"},"baseColor":{"type":"string"},"notchColor":{"type":"string"},"notchSpacing":{"type":"number"},"notchWidth":{"type":"number"},"traficFlow":{"type":"string"},"desc1":{"type":"string"},"desc2":{"type":"string"},"desc3":{"type":"string"},"desc4":{"type":"string"},"desc5":{"type":"string"},"desc6":{"type":"string"},"desc7":{"type":"string"},"desc8":{"type":"string"},"desc9":{"type":"string"},"desc10":{"type":"string"},"annualProfitAllocated":{"type":"string"},"capacityCost":{"type":"string"},"capacityRetail":{"type":"string"},"costAllocated":{"type":"string"},"marginAllocated":{"type":"number"},"numberOfStores":{"type":"integer"},"roiiCost":{"type":"string"},"roiiRetail":{"type":"string"},"salesAllocated":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/definitions/Segment"}}}},"Segment":{"type":"object","properties":{"segmentNo":{"type":"integer"},"width":{"type":"number"}}},"PlanogramGroup":{"type":"object","properties":{"id":{"type":"string"},"indexNo":{"type":"integer"},"name":{"type":"string"}}},"PlanogramSequence":{"type":"object","properties":{"id":{"type":"string"},"indexNo":{"type":"integer"},"name":{"type":"string"},"planograms":{"type":"array","items":{"$ref":"#/definitions/Section"}}}},"Section":{"type":"object","properties":{"name":{"type":"string"},"sequenceNo":{"type":"integer"}}},"Fixture":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"color":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"grilleHeight":{"type":"number"},"merch":{"type":"number"},"linear":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"},"slope":{"type":"number"},"angle":{"type":"number"},"roll":{"type":"number"},"curve":{"type":"number"},"assembly":{"type":"string"},"canCombine":{"type":"string"},"canObstruct":{"type":"string"},"dividerDepth":{"type":"number"},"dividerHeight":{"type":"number"},"dividerWidth":{"type":"number"},"fillPattern":{"type":"string"},"leftOverhang":{"type":"number"},"rightOverhang":{"type":"number"},"frontOverhang":{"type":"number"},"backOverhang":{"type":"number"},"lowerOverhang":{"type":"number"},"upperOverhang":{"type":"number"},"notch":{"type":"number"},"notchOffset":{"type":"number"},"pegDrop":{"type":"number"},"pegGapX":{"type":"number"},"pegGapY":{"type":"number"},"shapeId":{"type":"string"},"wallDepth":{"type":"number"},"wallHeight":{"type":"number"},"wallWidth":{"type":"number"},"availableLinear":{"type":"number"},"availableSquare":{"type":"number"},"availableCubic":{"type":"number"},"cubic":{"type":"number"},"locationId":{"type":"integer"},"numberOfDividers":{"type":"integer"},"numberOfPositions":{"type":"integer"},"rows":{"type":"integer"},"segment":{"type":"integer"},"warning":{"type":"string"},"desc1":{"type":"string"},"desc2":{"type":"string"},"desc3":{"type":"string"},"flag1":{"type":"string"},"flag2":{"type":"string"},"flag3":{"type":"string"},"value1":{"type":"number"},"value2":{"type":"number"},"value3":{"type":"number"}}},"Product":{"type":"object","properties":{"recordType":{"type":"string"},"name":{"type":"string"},"upc":{"type":"string"},"gtin":{"type":"string"},"price":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"},"z":{"type":"number"},"slope":{"type":"number"},"angle":{"type":"number"},"height":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"wide":{"type":"integer"},"high":{"type":"integer"},"deep":{"type":"integer"},"merchantStyle":{"type":"string"},"orientation":{"type":"string"}}},"Record":{"type":"object","properties":{"Record_Num":{"type":"integer"},"Date_Time":{"type":"string"},"UPC":{"type":"string"},"4D_Start_Processing_API":{"type":"string"},"Image_Version":{"type":"string"},"Product_Shape_Rect_Soda_Cylinder":{"type":"string"},"Product_Image_Height":{"type":"number"},"Product_Image_Width":{"type":"number"},"Product_Image_Depth":{"type":"number"},"Generate_Test_Images_Y_N":{"type":"string"},"Images_BB_Rotation_in_degrees":{"type":"string"},"Image_BB_Output_Height_pix":{"type":"number"},"Generate_360_Video_Y_N":{"type":"string"},"Video_BB_Output_Height_pix":{"type":"number"},"Video_Num_of_Frames_In_360":{"type":"number"},"Texture_1":{"type":"string"},"Texture_2":{"type":"string"},"Texture_3":{"type":"string"},"Texture_4":{"type":"string"},"Texture_5":{"type":"string"},"Texture_6":{"type":"string"},"Texture_7":{"type":"string"},"Texture_8":{"type":"string"},"Texture_9":{"type":"string"},"Texture_10":{"type":"string"},"Texture_11":{"type":"string"},"Texture_12":{"type":"string"},"Output_Local_Path_Y_N":{"type":"string"},"Local_Path":{"type":"string"},"Output_Remote_Image_Server_Path_Y_N":{"type":"string"},"Remote_Server_Image_Path":{"type":"string"},"4D_End_Processing_API":{"type":"string"},"3DS_Max_Project_Name":{"type":"string"},"3DS_Max_Model_Name_1":{"type":"string"},"3DS_Max_Model_Texture_Map_File_Name_1":{"type":"string"}}},"Company":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"Store":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"company":{"type":"string"}}}},"parameters":{"planogramName":{"name":"name","type":"string","in":"query","required":true,"description":"Planogram Name (Eg - 6ADA0800.TLN)"},"recordNo":{"name":"recordNo","type":"integer","in":"query","required":true,"description":"Record number"},"accessToken":{"name":"token","type":"string","in":"query","required":true,"description":"Access token"}}}