Configuration API (0.1.0)

Download OpenAPI specification:Download

Team Inventory: team-inventory@newstore.com URL: http://docs.newstore.net/

Represents the API to request the inventory's configurations.

Configuration API

Represents the API to request the inventory's configurations.

Get Fulfillment App Config

Example: /stock_locations/address_url/base_url business_area = stock_locations config_path = address_url/base_url

header Parameters

tenant

required

string (Tenant)

Responses

Response samples

200
422

Content type

application/json

null

Patch Fulfillment App Config

header Parameters

tenant

required

string (Tenant)

Request Body schema: application/json

	object (Adjustment) Default: {"manual_adjustment_enabled":false}
	object (Cycle Count) Default: {"count_modification_enabled":false,"stock_on_hand_visible":false}
	object (Receiving) Default: {"blind_receiving_enabled":false,"manual_receiving_enabled":false,"order_ref":{"enabled":false,"label":"Order Reference"},"shipment_ref":{"enabled":false,"label":"Shipment Reference"}}
	object (Transfer) Default: {"manual_adjustment_enabled":false}

Responses

Request samples

Payload

Content type

application/json

{"adjustment": {"manual_adjustment_enabled": false
},
"cycle_count": {"count_modification_enabled": false,
"stock_on_hand_visible": false
},
"receiving": {"blind_receiving_enabled": false,
"manual_receiving_enabled": false,
"order_ref": {"enabled": false,
"label": "Order Reference"
},
"shipment_ref": {"enabled": false,
"label": "Shipment Reference"
}
},
"transfer": {"manual_adjustment_enabled": false
}
}

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Set Fulfillment App Config

header Parameters

tenant

required

string (Tenant)

Request Body schema: application/json

required	object (RequiredAdjustmentConfig)
required	object (RequiredCycleCountConfig)
required	object (RequiredReceivingConfig)
required	object (RequiredTransferConfig)

Responses

Request samples

Payload

Content type

application/json

{"adjustment": {"manual_adjustment_enabled": true
},
"cycle_count": {"count_modification_enabled": true,
"stock_on_hand_visible": true
},
"receiving": {"blind_receiving_enabled": true,
"manual_receiving_enabled": true,
"order_ref": {"enabled": true,
"label": "string"
},
"shipment_ref": {"enabled": true,
"label": "string"
}
},
"transfer": {"manual_adjustment_enabled": true
}
}

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Health Check

Responses

Get Config

Example: /stock_locations/address_url/base_url business_area = stock_locations config_path = address_url/base_url

path Parameters

business_area required	string (Business Area)
config_path required	string (Config Path)

header Parameters

tenant

required

string (Tenant)

Responses

Response samples

200
422

Content type

application/json

null

Set Config

path Parameters

business_area required	string (Business Area)
config_path required	string (Config Path)

header Parameters

tenant

required

string (Tenant)

Request Body schema: application/json

	Value (object) or Array of Value (any) or Value (string) or Value (integer) or Value (number) or Value (boolean) or FulfillmentAppConfig (object) or RequiredFulfillmentAppConfig (object) (Value)
Any of object (Value)

Responses

Request samples

Payload

Content type

application/json

{"value": { }
}

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}